mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2025-12-30 17:00:57 -06:00
Start to publish documentation
This commit is contained in:
@@ -10,7 +10,10 @@ def main(ctx):
|
||||
binary('windows'),
|
||||
]
|
||||
|
||||
after = manifest()
|
||||
after = [
|
||||
manifest(),
|
||||
documentation()
|
||||
]
|
||||
|
||||
for b in before:
|
||||
for s in stages:
|
||||
@@ -385,7 +388,7 @@ def binary(name):
|
||||
}
|
||||
|
||||
def manifest():
|
||||
return [{
|
||||
return {
|
||||
'kind': 'pipeline',
|
||||
'type': 'docker',
|
||||
'name': 'manifest',
|
||||
@@ -424,4 +427,54 @@ def manifest():
|
||||
'refs/tags/**'
|
||||
]
|
||||
}
|
||||
}]
|
||||
}
|
||||
|
||||
def documentation():
|
||||
return {
|
||||
'kind': 'pipeline',
|
||||
'type': 'docker',
|
||||
'name': 'documentation',
|
||||
'platform': {
|
||||
'os': 'linux',
|
||||
'arch': 'amd64',
|
||||
},
|
||||
'steps': [
|
||||
{
|
||||
'name': 'generate',
|
||||
'image': 'webhippie/hugo:latest',
|
||||
'pull': 'always',
|
||||
'commands': [
|
||||
'make docs'
|
||||
]
|
||||
},
|
||||
{
|
||||
'name': 'publish',
|
||||
'image': 'plugins/gh-pages:1',
|
||||
'pull': 'always',
|
||||
'settings': {
|
||||
'username': {
|
||||
'from_secret': 'github_username'
|
||||
},
|
||||
'password': {
|
||||
'from_secret': 'github_token'
|
||||
},
|
||||
'pages_directory': 'docs/public/',
|
||||
'temporary_base': 'tmp/',
|
||||
},
|
||||
'when': {
|
||||
'event': {
|
||||
'exclude': [
|
||||
'pull_request'
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
],
|
||||
'depends_on': [],
|
||||
'trigger': {
|
||||
'ref': [
|
||||
'refs/heads/master',
|
||||
'refs/pull/**'
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
44
.drone.yml
44
.drone.yml
@@ -649,4 +649,48 @@ depends_on:
|
||||
- darwin
|
||||
- windows
|
||||
|
||||
---
|
||||
kind: pipeline
|
||||
type: docker
|
||||
name: documentation
|
||||
|
||||
platform:
|
||||
os: linux
|
||||
arch: amd64
|
||||
|
||||
steps:
|
||||
- name: generate
|
||||
pull: always
|
||||
image: webhippie/hugo:latest
|
||||
commands:
|
||||
- make docs
|
||||
|
||||
- name: publish
|
||||
pull: always
|
||||
image: plugins/gh-pages:1
|
||||
settings:
|
||||
pages_directory: docs/public/
|
||||
password:
|
||||
from_secret: github_token
|
||||
temporary_base: tmp/
|
||||
username:
|
||||
from_secret: github_username
|
||||
when:
|
||||
event:
|
||||
exclude:
|
||||
- pull_request
|
||||
|
||||
trigger:
|
||||
ref:
|
||||
- refs/heads/master
|
||||
- refs/pull/**
|
||||
|
||||
depends_on:
|
||||
- amd64
|
||||
- arm64
|
||||
- arm
|
||||
- linux
|
||||
- darwin
|
||||
- windows
|
||||
|
||||
...
|
||||
|
||||
3
.github/settings.yml
vendored
3
.github/settings.yml
vendored
@@ -1,7 +1,8 @@
|
||||
---
|
||||
repository:
|
||||
name: ocis
|
||||
description: ':atom_symbol: ownCloud Infinit Scale stack'
|
||||
description: ':atom_symbol: ownCloud Infinite Scale Stack'
|
||||
homepage: https://owncloud.github.io/ocis/
|
||||
topics: reva, ocis
|
||||
|
||||
private: false
|
||||
|
||||
4
Makefile
4
Makefile
@@ -125,3 +125,7 @@ gorunpkg:
|
||||
ifndef HAS_GORUNPKG
|
||||
go get -u github.com/vektah/gorunpkg
|
||||
endif
|
||||
|
||||
.PHONY: docs
|
||||
docs:
|
||||
cd docs; hugo
|
||||
|
||||
3
config/.gitignore
vendored
3
config/.gitignore
vendored
@@ -1 +1,2 @@
|
||||
hyper.yml
|
||||
ocis.yml
|
||||
ocis.json
|
||||
|
||||
1
config/example.json
Normal file
1
config/example.json
Normal file
@@ -0,0 +1 @@
|
||||
{}
|
||||
@@ -0,0 +1,3 @@
|
||||
---
|
||||
|
||||
...
|
||||
|
||||
6
docs/archetypes/default.md
Normal file
6
docs/archetypes/default.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: "{{ replace .TranslationBaseName "-" " " | title }}"
|
||||
date: {{ .Date }}
|
||||
anchor: "{{ replace .TranslationBaseName "-" " " | title | urlize }}"
|
||||
weight:
|
||||
---
|
||||
16
docs/config.toml
Normal file
16
docs/config.toml
Normal file
@@ -0,0 +1,16 @@
|
||||
baseURL = "https://owncloud.github.io/ocis/"
|
||||
languageCode = "en-us"
|
||||
title = "ownCloud Infinite Scale Stack"
|
||||
pygmentsUseClasses = true
|
||||
|
||||
[blackfriday]
|
||||
angledQuotes = true
|
||||
fractions = false
|
||||
plainIDAnchors = true
|
||||
smartlists = true
|
||||
extensions = ["hardLineBreak"]
|
||||
|
||||
[params]
|
||||
author = "ownCloud GmbH"
|
||||
description = "Launch all oCIS services"
|
||||
keywords = "reva, ocis"
|
||||
8
docs/content/about.md
Normal file
8
docs/content/about.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "About"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "about"
|
||||
weight: 10
|
||||
---
|
||||
|
||||
This tool provides a single entrypoint for the whole ownCloud Infinite Scale stack.
|
||||
28
docs/content/building.md
Normal file
28
docs/content/building.md
Normal file
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: "Building"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "building"
|
||||
weight: 30
|
||||
---
|
||||
|
||||
As this project is built with Go, so you need to install that first. The installation of Go is out of the scope of this document, please follow the official documentation for [Go](golang). After the installation of the required tools you need to get the sources:
|
||||
|
||||
{{< highlight txt >}}
|
||||
git clone https://github.com/owncloud/ocis.git
|
||||
cd ocis
|
||||
{{< / highlight >}}
|
||||
|
||||
All required tool besides Go itself and make are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile` and respectively our `package.json`.
|
||||
|
||||
## Backend
|
||||
|
||||
{{< highlight txt >}}
|
||||
make generate
|
||||
make build
|
||||
{{< / highlight >}}
|
||||
|
||||
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis -h` to see all available options.
|
||||
|
||||
[golang]: https://golang.org/doc/install
|
||||
[nodejs]: https://nodejs.org/en/download/package-manager/
|
||||
[yarn]: https://yarnpkg.com/lang/en/docs/install/
|
||||
230
docs/content/getting-started.md
Normal file
230
docs/content/getting-started.md
Normal file
@@ -0,0 +1,230 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "getting-started"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
So far we are offering two different variants for the installation. You can choose between [Docker](docker) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
|
||||
|
||||
### Docker
|
||||
|
||||
TBD
|
||||
|
||||
### Binaries
|
||||
|
||||
TBD
|
||||
|
||||
## Configuration
|
||||
|
||||
We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
|
||||
|
||||
### Envrionment variables
|
||||
|
||||
If you prefer to configure the service with environment variables you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
OCIS_LOG_LEVEL
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
OCIS_LOG_COLOR
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
OCIS_LOG_PRETTY
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
OCIS_DEBUG_ADDR
|
||||
: Address to bind debug server, defaults to `0.0.0.0:8001`
|
||||
|
||||
OCIS_DEBUG_TOKEN
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
OCIS_DEBUG_PPROF
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
OCIS_HTTP_ADDR
|
||||
: Address to bind http server, defaults to `0.0.0.0:8000`
|
||||
|
||||
OCIS_HTTP_ROOT
|
||||
: Root path for http endpoint, defaults to `/`
|
||||
|
||||
OCIS_SERVICES_ENABLED
|
||||
: List of enabled services, defaults to `phoenix,ocs,webdav,hello`
|
||||
|
||||
#### Health
|
||||
|
||||
OCIS_DEBUG_ADDR
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:8001`
|
||||
|
||||
### Commandline flags
|
||||
|
||||
If you prefer to configure the service with commandline flags you can see the available variables below.
|
||||
|
||||
#### Global
|
||||
|
||||
--log-level
|
||||
: Set logging level, defaults to `info`
|
||||
|
||||
--log-color
|
||||
: Enable colored logging, defaults to `true`
|
||||
|
||||
--log-pretty
|
||||
: Enable pretty logging, defaults to `true`
|
||||
|
||||
#### Server
|
||||
|
||||
--debug-addr
|
||||
: Address to bind debug server, defaults to `0.0.0.0:8001`
|
||||
|
||||
--debug-token
|
||||
: Token to grant metrics access, empty default value
|
||||
|
||||
--debug-pprof
|
||||
: Enable pprof debugging, defaults to `false`
|
||||
|
||||
--http-addr
|
||||
: Address to bind http server, defaults to `0.0.0.0:8000`
|
||||
|
||||
--http-root
|
||||
: Root path for http endpoint, defaults to `/`
|
||||
|
||||
--services-enabled
|
||||
: List of enabled services, defaults to `phoenix,ocs,webdav,hello`
|
||||
|
||||
#### Health
|
||||
|
||||
--debug-addr
|
||||
: Address to debug endpoint, defaults to `0.0.0.0:8001`
|
||||
|
||||
### Configuration file
|
||||
|
||||
So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](repo), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`.
|
||||
|
||||
## Usage
|
||||
|
||||
The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis --help`.
|
||||
|
||||
### Server
|
||||
|
||||
The server command is used to start the http and debug server on two addresses within a single process. The http server is serving the general webservice while the debug server is used for health check, readiness check and to server the metrics mentioned below. For further help please execute:
|
||||
|
||||
{{< highlight txt >}}
|
||||
ocis server --help
|
||||
{{< / highlight >}}
|
||||
|
||||
### Health
|
||||
|
||||
The health command is used to execute a health check, if the exit code equals zero the service should be up and running, if the exist code is greater than zero the service is not in a healthy state. Generally this command is used within our Docker containers, it could also be used within Kubernetes.
|
||||
|
||||
{{< highlight txt >}}
|
||||
ocis health --help
|
||||
{{< / highlight >}}
|
||||
|
||||
## Metrics
|
||||
|
||||
This service provides some [Prometheus](prom) metrics through the debug endpoint, you can optionally secure the metrics endpoint by some random token, which got to be configured through one of the flag `--debug-token` or the environment variable `OCIS_DEBUG_TOKEN` mentioned above. By default the metrics endpoint is bound to `http://0.0.0.0:8001/metrics`.
|
||||
|
||||
go_gc_duration_seconds
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_sum
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_gc_duration_seconds_count
|
||||
: A summary of the GC invocation durations
|
||||
|
||||
go_goroutines
|
||||
: Number of goroutines that currently exist
|
||||
|
||||
go_info
|
||||
: Information about the Go environment
|
||||
|
||||
go_memstats_alloc_bytes
|
||||
: Number of bytes allocated and still in use
|
||||
|
||||
go_memstats_alloc_bytes_total
|
||||
: Total number of bytes allocated, even if freed
|
||||
|
||||
go_memstats_buck_hash_sys_bytes
|
||||
: Number of bytes used by the profiling bucket hash table
|
||||
|
||||
go_memstats_frees_total
|
||||
: Total number of frees
|
||||
|
||||
go_memstats_gc_cpu_fraction
|
||||
: The fraction of this program's available CPU time used by the GC since the program started
|
||||
|
||||
go_memstats_gc_sys_bytes
|
||||
: Number of bytes used for garbage collection system metadata
|
||||
|
||||
go_memstats_heap_alloc_bytes
|
||||
: Number of heap bytes allocated and still in use
|
||||
|
||||
go_memstats_heap_idle_bytes
|
||||
: Number of heap bytes waiting to be used
|
||||
|
||||
go_memstats_heap_inuse_bytes
|
||||
: Number of heap bytes that are in use
|
||||
|
||||
go_memstats_heap_objects
|
||||
: Number of allocated objects
|
||||
|
||||
go_memstats_heap_released_bytes
|
||||
: Number of heap bytes released to OS
|
||||
|
||||
go_memstats_heap_sys_bytes
|
||||
: Number of heap bytes obtained from system
|
||||
|
||||
go_memstats_last_gc_time_seconds
|
||||
: Number of seconds since 1970 of last garbage collection
|
||||
|
||||
go_memstats_lookups_total
|
||||
: Total number of pointer lookups
|
||||
|
||||
go_memstats_mallocs_total
|
||||
: Total number of mallocs
|
||||
|
||||
go_memstats_mcache_inuse_bytes
|
||||
: Number of bytes in use by mcache structures
|
||||
|
||||
go_memstats_mcache_sys_bytes
|
||||
: Number of bytes used for mcache structures obtained from system
|
||||
|
||||
go_memstats_mspan_inuse_bytes
|
||||
: Number of bytes in use by mspan structures
|
||||
|
||||
go_memstats_mspan_sys_bytes
|
||||
: Number of bytes used for mspan structures obtained from system
|
||||
|
||||
go_memstats_next_gc_bytes
|
||||
: Number of heap bytes when next garbage collection will take place
|
||||
|
||||
go_memstats_other_sys_bytes
|
||||
: Number of bytes used for other system allocations
|
||||
|
||||
go_memstats_stack_inuse_bytes
|
||||
: Number of bytes in use by the stack allocator
|
||||
|
||||
go_memstats_stack_sys_bytes
|
||||
: Number of bytes obtained from system for stack allocator
|
||||
|
||||
go_memstats_sys_bytes
|
||||
: Number of bytes obtained from system
|
||||
|
||||
go_threads
|
||||
: Number of OS threads created
|
||||
|
||||
promhttp_metric_handler_requests_in_flight
|
||||
: Current number of scrapes being served
|
||||
|
||||
promhttp_metric_handler_requests_total
|
||||
: Total number of scrapes by HTTP status code
|
||||
|
||||
[docker]: https://www.docker.com/
|
||||
[repo]: https://github.com/owncloud/ocis/tree/master/config
|
||||
[prom]: https://prometheus.io/
|
||||
10
docs/content/license.md
Normal file
10
docs/content/license.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: "License"
|
||||
date: 2018-05-02T00:00:00+00:00
|
||||
anchor: "license"
|
||||
weight: 40
|
||||
---
|
||||
|
||||
This project is licensed under the [Apache 2.0](license) license. For the license of the used libraries you have to check the respective sources.
|
||||
|
||||
[license]: https://github.com/owncloud/ocis/blob/master/LICENSE
|
||||
0
docs/layouts/_default/list.html
Normal file
0
docs/layouts/_default/list.html
Normal file
0
docs/layouts/_default/single.html
Normal file
0
docs/layouts/_default/single.html
Normal file
57
docs/layouts/index.html
Normal file
57
docs/layouts/index.html
Normal file
@@ -0,0 +1,57 @@
|
||||
<!DOCTYPE html>
|
||||
|
||||
<html id="html" lang="{{ with .Site.LanguageCode }}{{ . }}{{ else }}en-US{{ end }}">
|
||||
<head>
|
||||
<meta http-equiv="content-type" content="text/html;charset=utf-8">
|
||||
<meta name="viewport" content="width=device-width"/>
|
||||
|
||||
<title>
|
||||
{{ .Site.Title }}
|
||||
</title>
|
||||
|
||||
<meta name="description" content="{{ with .Site.Params.description }}{{ . }}{{ end }}">
|
||||
<meta name="author" content="{{ with .Site.Params.author }}{{ . }}{{ end }}">
|
||||
|
||||
{{ partial "style.html" . }}
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<section id="Menu">
|
||||
<header>
|
||||
<h1>
|
||||
{{ .Site.Title }}
|
||||
</h1>
|
||||
|
||||
<p>
|
||||
{{ .Site.Params.description }}
|
||||
</p>
|
||||
</header>
|
||||
|
||||
<nav>
|
||||
{{ range .Data.Pages.ByWeight }}
|
||||
<a href="#{{ .Params.anchor }}">
|
||||
{{ .Title }}
|
||||
</a>
|
||||
{{ end }}
|
||||
</nav>
|
||||
</section>
|
||||
|
||||
{{ range .Data.Pages.ByWeight }}
|
||||
<section id="{{ .Params.anchor }}">
|
||||
<h1>
|
||||
<a href="#{{ .Params.anchor }}">
|
||||
{{ .Title }}
|
||||
</a>
|
||||
|
||||
<small>
|
||||
<a href="#html">
|
||||
Back to Top
|
||||
</a>
|
||||
</small>
|
||||
</h1>
|
||||
|
||||
{{ .Content | markdownify }}
|
||||
</section>
|
||||
{{ end }}
|
||||
</body>
|
||||
</html>
|
||||
337
docs/layouts/partials/style.html
Normal file
337
docs/layouts/partials/style.html
Normal file
@@ -0,0 +1,337 @@
|
||||
<link rel="stylesheet" href="syntax.css" />
|
||||
|
||||
<style type="text/css">
|
||||
body,
|
||||
div,
|
||||
dl,
|
||||
dt,
|
||||
dd,
|
||||
ul,
|
||||
ol,
|
||||
li,
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6,
|
||||
pre,
|
||||
form,
|
||||
fieldset,
|
||||
input,
|
||||
textarea,
|
||||
p,
|
||||
blockquote,
|
||||
th,
|
||||
td {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
* {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
:before,
|
||||
:after {
|
||||
-webkit-box-sizing: border-box;
|
||||
-moz-box-sizing: border-box;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
img,
|
||||
object,
|
||||
embed {
|
||||
max-width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
object,
|
||||
embed {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
img {
|
||||
margin: 1.25% 0;
|
||||
-ms-interpolation-mode: bicubic;
|
||||
}
|
||||
|
||||
html {
|
||||
background-color: #F0F1F3;
|
||||
padding: 2%;
|
||||
}
|
||||
|
||||
body {
|
||||
font-size: 16px;
|
||||
line-height: 1.6;
|
||||
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
|
||||
color: #242424;
|
||||
max-width: 800px;
|
||||
margin: 5% auto;
|
||||
}
|
||||
|
||||
body::after {
|
||||
clear: both;
|
||||
content: "";
|
||||
display: table;
|
||||
}
|
||||
|
||||
header {
|
||||
margin-bottom: 8%;
|
||||
}
|
||||
|
||||
footer {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h1 a {
|
||||
color: #263A48;
|
||||
font-weight: 500;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
h1,
|
||||
h2 {
|
||||
font-size: 36px;
|
||||
padding-bottom: 0.3em;
|
||||
margin-bottom: 0.4em;
|
||||
border-bottom: 1px solid #eee
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 22px;
|
||||
padding-bottom: 0.6em;
|
||||
margin-bottom: 0.6em;
|
||||
margin-top: 2.5em;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 18px;
|
||||
margin-bottom: 0.3em;
|
||||
}
|
||||
|
||||
h1 small a {
|
||||
color: #98999C;
|
||||
font-size: 15px;
|
||||
font-weight: normal;
|
||||
float: right;
|
||||
position: absolute;
|
||||
top: 15px;
|
||||
right: 20px;
|
||||
}
|
||||
|
||||
section {
|
||||
background: #fff;
|
||||
margin-bottom: 1%;
|
||||
position: relative;
|
||||
padding: 6% 8%;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
border-left: 3px solid #d54e21;
|
||||
font-size: 16px;
|
||||
padding: 0 0 0 20px;
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
blockquote a {
|
||||
color: #d54e21;
|
||||
font-weight: 500;
|
||||
}
|
||||
|
||||
blockquote code {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
.highlight pre {
|
||||
padding: 10px;
|
||||
}
|
||||
|
||||
.highlight {
|
||||
margin-bottom: 4%;
|
||||
}
|
||||
|
||||
a {
|
||||
color: #1e8cbe;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
ol {
|
||||
list-style: number;
|
||||
}
|
||||
|
||||
ol li {
|
||||
color: #98999C;
|
||||
margin-bottom: 5px;
|
||||
}
|
||||
|
||||
ol li:last-child {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p,
|
||||
ul,
|
||||
ol,
|
||||
blockquote {
|
||||
margin-bottom: 4%;
|
||||
}
|
||||
|
||||
ul ul {
|
||||
padding-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 4%;
|
||||
}
|
||||
|
||||
ul ul li:before {
|
||||
content: '-';
|
||||
display: inline-block;
|
||||
padding-right: 2%;
|
||||
}
|
||||
|
||||
ul.col-2 {
|
||||
color: #98999C;
|
||||
-webkit-column-count: 2;
|
||||
-moz-column-count: 2;
|
||||
column-count: 2;
|
||||
-webkit-column-gap: 20px;
|
||||
-moz-column-gap: 20px;
|
||||
column-gap: 20px;
|
||||
}
|
||||
|
||||
dl dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
dl dd {
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
@media screen and (min-width: 500px) {
|
||||
ul.col-2 {
|
||||
-webkit-column-count: 3;
|
||||
-moz-column-count: 3;
|
||||
column-count: 3;
|
||||
-webkit-column-gap: 20px;
|
||||
-moz-column-gap: 20px;
|
||||
column-gap: 20px;
|
||||
}
|
||||
}
|
||||
|
||||
nav {
|
||||
background: #F0F1F3;
|
||||
min-width: 215px;
|
||||
margin-bottom: 5px;
|
||||
margin-top: 15px;
|
||||
}
|
||||
|
||||
nav:first-of-type a {
|
||||
color: #d54e21;
|
||||
border-radius: 0;
|
||||
}
|
||||
|
||||
nav:first-of-type a:hover {
|
||||
color: #d54e21;
|
||||
}
|
||||
|
||||
nav:first-of-type a:before {
|
||||
background-color: #d54e21;
|
||||
}
|
||||
|
||||
nav.affix {
|
||||
position: fixed;
|
||||
top: 20px;
|
||||
}
|
||||
|
||||
nav.affix-bottom {
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
nav a {
|
||||
border-radius: 3px;
|
||||
font-size: 15px;
|
||||
display: block;
|
||||
cursor: pointer;
|
||||
font-weight: 500;
|
||||
position: relative;
|
||||
text-decoration: none;
|
||||
padding: 10px 12px;
|
||||
width: 100%;
|
||||
padding-right: 3px;
|
||||
border-bottom: 2px solid #fff;
|
||||
}
|
||||
|
||||
nav a:before {
|
||||
content: '';
|
||||
width: 4px;
|
||||
display: block;
|
||||
left: 0;
|
||||
position: absolute;
|
||||
height: 100%;
|
||||
display: none;
|
||||
background: #1e8cbe;
|
||||
top: 0;
|
||||
}
|
||||
|
||||
nav a:hover {
|
||||
background-color: #E6E8EA;
|
||||
color: #1e8cbe;
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
nav a:hover:before {
|
||||
display: block;
|
||||
}
|
||||
|
||||
nav a:last-of-type {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
.gist {
|
||||
margin-top: 5.1%;
|
||||
margin-bottom: 5%;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 1050px) {
|
||||
body {
|
||||
margin: 0 auto;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 767px) {
|
||||
header span {
|
||||
display: none;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 26px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 20px;
|
||||
}
|
||||
}
|
||||
|
||||
@media screen and (max-width: 514px) {
|
||||
p,
|
||||
ul,
|
||||
ol,
|
||||
blockquote {
|
||||
margin-bottom: 8%;
|
||||
}
|
||||
}
|
||||
</style>
|
||||
59
docs/static/syntax.css
vendored
Normal file
59
docs/static/syntax.css
vendored
Normal file
@@ -0,0 +1,59 @@
|
||||
/* Background */ .chroma { color: #f8f8f2; background-color: #272822 }
|
||||
/* Error */ .chroma .err { color: #960050; background-color: #1e0010 }
|
||||
/* LineTableTD */ .chroma .lntd { vertical-align: top; padding: 0; margin: 0; border: 0; }
|
||||
/* LineTable */ .chroma .lntable { border-spacing: 0; padding: 0; margin: 0; border: 0; width: auto; overflow: auto; display: block; }
|
||||
/* LineHighlight */ .chroma .hl { display: block; width: 100%;background-color: #ffffcc }
|
||||
/* LineNumbersTable */ .chroma .lnt { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; }
|
||||
/* LineNumbers */ .chroma .ln { margin-right: 0.4em; padding: 0 0.4em 0 0.4em; }
|
||||
/* Keyword */ .chroma .k { color: #66d9ef }
|
||||
/* KeywordConstant */ .chroma .kc { color: #66d9ef }
|
||||
/* KeywordDeclaration */ .chroma .kd { color: #66d9ef }
|
||||
/* KeywordNamespace */ .chroma .kn { color: #f92672 }
|
||||
/* KeywordPseudo */ .chroma .kp { color: #66d9ef }
|
||||
/* KeywordReserved */ .chroma .kr { color: #66d9ef }
|
||||
/* KeywordType */ .chroma .kt { color: #66d9ef }
|
||||
/* NameAttribute */ .chroma .na { color: #a6e22e }
|
||||
/* NameClass */ .chroma .nc { color: #a6e22e }
|
||||
/* NameConstant */ .chroma .no { color: #66d9ef }
|
||||
/* NameDecorator */ .chroma .nd { color: #a6e22e }
|
||||
/* NameException */ .chroma .ne { color: #a6e22e }
|
||||
/* NameFunction */ .chroma .nf { color: #a6e22e }
|
||||
/* NameOther */ .chroma .nx { color: #a6e22e }
|
||||
/* NameTag */ .chroma .nt { color: #f92672 }
|
||||
/* Literal */ .chroma .l { color: #ae81ff }
|
||||
/* LiteralDate */ .chroma .ld { color: #e6db74 }
|
||||
/* LiteralString */ .chroma .s { color: #e6db74 }
|
||||
/* LiteralStringAffix */ .chroma .sa { color: #e6db74 }
|
||||
/* LiteralStringBacktick */ .chroma .sb { color: #e6db74 }
|
||||
/* LiteralStringChar */ .chroma .sc { color: #e6db74 }
|
||||
/* LiteralStringDelimiter */ .chroma .dl { color: #e6db74 }
|
||||
/* LiteralStringDoc */ .chroma .sd { color: #e6db74 }
|
||||
/* LiteralStringDouble */ .chroma .s2 { color: #e6db74 }
|
||||
/* LiteralStringEscape */ .chroma .se { color: #ae81ff }
|
||||
/* LiteralStringHeredoc */ .chroma .sh { color: #e6db74 }
|
||||
/* LiteralStringInterpol */ .chroma .si { color: #e6db74 }
|
||||
/* LiteralStringOther */ .chroma .sx { color: #e6db74 }
|
||||
/* LiteralStringRegex */ .chroma .sr { color: #e6db74 }
|
||||
/* LiteralStringSingle */ .chroma .s1 { color: #e6db74 }
|
||||
/* LiteralStringSymbol */ .chroma .ss { color: #e6db74 }
|
||||
/* LiteralNumber */ .chroma .m { color: #ae81ff }
|
||||
/* LiteralNumberBin */ .chroma .mb { color: #ae81ff }
|
||||
/* LiteralNumberFloat */ .chroma .mf { color: #ae81ff }
|
||||
/* LiteralNumberHex */ .chroma .mh { color: #ae81ff }
|
||||
/* LiteralNumberInteger */ .chroma .mi { color: #ae81ff }
|
||||
/* LiteralNumberIntegerLong */ .chroma .il { color: #ae81ff }
|
||||
/* LiteralNumberOct */ .chroma .mo { color: #ae81ff }
|
||||
/* Operator */ .chroma .o { color: #f92672 }
|
||||
/* OperatorWord */ .chroma .ow { color: #f92672 }
|
||||
/* Comment */ .chroma .c { color: #75715e }
|
||||
/* CommentHashbang */ .chroma .ch { color: #75715e }
|
||||
/* CommentMultiline */ .chroma .cm { color: #75715e }
|
||||
/* CommentSingle */ .chroma .c1 { color: #75715e }
|
||||
/* CommentSpecial */ .chroma .cs { color: #75715e }
|
||||
/* CommentPreproc */ .chroma .cp { color: #75715e }
|
||||
/* CommentPreprocFile */ .chroma .cpf { color: #75715e }
|
||||
/* GenericDeleted */ .chroma .gd { color: #f92672 }
|
||||
/* GenericEmph */ .chroma .ge { font-style: italic }
|
||||
/* GenericInserted */ .chroma .gi { color: #a6e22e }
|
||||
/* GenericStrong */ .chroma .gs { font-weight: bold }
|
||||
/* GenericSubheading */ .chroma .gu { color: #75715e }
|
||||
Reference in New Issue
Block a user