Update doc/book.toml, doc/src/SUMMARY.md, doc/src/readme.md, employee-handbook_mermaid.css, employee-handbook_mermaid-init.js, employee-handbook_mermaid.min.js files

Deleted Gemfile, Gemfile.lock, _config.yml files
This commit is contained in:
Niklas Zender 2020-05-17 08:01:09 +00:00 committed by Christian Pauly
parent 729f1f3b78
commit 1ca6c2e3bd
11 changed files with 468 additions and 92 deletions

View file

@ -3,12 +3,11 @@ stages:
- builddocs - builddocs
- deploy - deploy
variables:
JEKYLL_ENV: production
coverage: coverage:
image: debian:testing tags:
- linux
stage: coverage stage: coverage
image: debian:testing
coverage: '/^\s+lines.+: (\d+.\d*%)/' coverage: '/^\s+lines.+: (\d+.\d*%)/'
dependencies: [] dependencies: []
script: script:
@ -27,8 +26,10 @@ coverage:
- su -c ./test.sh test - su -c ./test.sh test
coverage_without_olm: coverage_without_olm:
image: debian:testing tags:
- linux
stage: coverage stage: coverage
image: debian:testing
coverage: '/^\s+lines.+: (\d+.\d*%)/' coverage: '/^\s+lines.+: (\d+.\d*%)/'
dependencies: [] dependencies: []
script: script:
@ -44,13 +45,17 @@ coverage_without_olm:
- pub run test - pub run test
code_analyze: code_analyze:
image: cirrusci/flutter tags:
- docker
stage: coverage stage: coverage
image: cirrusci/flutter
dependencies: [] dependencies: []
script: script:
- flutter analyze - flutter analyze
builddocs: build-api-doc:
tags:
- docker
stage: builddocs stage: builddocs
image: cirrusci/flutter image: cirrusci/flutter
script: script:
@ -61,17 +66,36 @@ builddocs:
only: only:
- master - master
pages: build-doc:
stage: deploy tags:
image: ruby:2.3 - docker
stage: builddocs
image: registry.gitlab.com/larodar/mdbook-dtmo:latest
script: script:
- mv doc/api/* ./ - cd doc
- bundle install - mdbook-dtmo build -d public
- bundle exec jekyll build -d public - mv public ../doc-public
artifacts:
paths:
- doc-public
only:
- master
pages:
tags:
- linux
stage: deploy
image: alpine:latest
script:
- mv doc/api/ ./home/api
- mv doc-public ./home/doc
- mv home public
dependencies: dependencies:
- builddocs - build-api-doc
- build-doc
artifacts: artifacts:
paths: paths:
- public - public
only: only:
- master - master

View file

@ -1,8 +0,0 @@
source "https://rubygems.org"
ruby RUBY_VERSION
# This will help ensure the proper Jekyll version is running.
gem "jekyll", "3.4.0"
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

View file

@ -1,51 +0,0 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.5.0)
public_suffix (~> 2.0, >= 2.0.2)
colorator (1.1.0)
ffi (1.9.17)
forwardable-extended (2.6.0)
jekyll (3.4.0)
addressable (~> 2.4)
colorator (~> 1.0)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 1.1)
kramdown (~> 1.3)
liquid (~> 3.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (~> 1.7)
safe_yaml (~> 1.0)
jekyll-sass-converter (1.5.0)
sass (~> 3.4)
jekyll-watch (1.5.0)
listen (~> 3.0, < 3.1)
kramdown (1.13.2)
liquid (3.0.6)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
mercenary (0.3.6)
pathutil (0.14.0)
forwardable-extended (~> 2.6)
public_suffix (2.0.5)
rb-fsevent (0.9.8)
rb-inotify (0.9.8)
ffi (>= 0.5.0)
rouge (1.11.1)
safe_yaml (1.0.4)
sass (3.4.23)
PLATFORMS
ruby
DEPENDENCIES
jekyll (= 3.4.0)
tzinfo-data
RUBY VERSION
ruby 2.3.1p112
BUNDLED WITH
1.13.6

View file

@ -1,18 +0,0 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely need to edit after that.
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'jekyll serve'. If you change this file, please restart the server process.
# Site settings
title: famedlysdk
email: p.kurtz@famedly.com
description: Documentation for famedylsdk
baseurl: "/famedlysdkdocs" # the subpath of your site, e.g. /blog
url: "/" # the base hostname & protocol for your site
gitlab_username: famedly
# Build settings
markdown: kramdown
exclude: [ "README.md", "LICENSE"]

14
doc/book.toml Normal file
View file

@ -0,0 +1,14 @@
[book]
title = "Famedly Matrix SDK Documentation"
description = "Famedly Matrix SDK Documentation"
[preprocessor.mermaid]
command = "mdbook-mermaid"
renderer = ["html"]
[preprocessor.toc]
command = "mdbook-toc"
[output.html]
additional-css = ["mermaid.css"]
additional-js = ["mermaid.min.js", "mermaid-init.js"]

1
doc/mermaid-init.js Normal file
View file

@ -0,0 +1 @@
mermaid.initialize({startOnLoad:true});

351
doc/mermaid.css Normal file
View file

@ -0,0 +1,351 @@
/* Flowchart variables */
/* Sequence Diagram variables */
/* Gantt chart variables */
.mermaid .mermaid .label {
color: #333;
}
.mermaid .node rect,
.mermaid .node circle,
.mermaid .node ellipse,
.mermaid .node polygon {
fill: #ECECFF;
stroke: #CCCCFF;
stroke-width: 1px;
}
.mermaid .arrowheadPath {
fill: #333333;
}
.mermaid .edgePath .path {
stroke: #333333;
}
.mermaid .edgeLabel {
background-color: #e8e8e8;
}
.mermaid .cluster rect {
fill: #ffffde !important;
rx: 4 !important;
stroke: #aaaa33 !important;
stroke-width: 1px !important;
}
.mermaid .cluster text {
fill: #333;
}
.mermaid .actor {
stroke: #CCCCFF;
fill: #ECECFF;
}
.mermaid text.actor {
fill: black;
stroke: none;
}
.mermaid .actor-line {
stroke: grey;
}
.mermaid .messageLine0 {
stroke-width: 1.5;
stroke-dasharray: "2 2";
marker-end: "url(#arrowhead)";
stroke: #333;
}
.mermaid .messageLine1 {
stroke-width: 1.5;
stroke-dasharray: "2 2";
stroke: #333;
}
.mermaid #arrowhead {
fill: #333;
}
.mermaid #crosshead path {
fill: #333 !important;
stroke: #333 !important;
}
.mermaid .messageText {
fill: #333;
stroke: none;
}
.mermaid .labelBox {
stroke: #CCCCFF;
fill: #ECECFF;
}
.mermaid .labelText {
fill: black;
stroke: none;
}
.mermaid .loopText {
fill: black;
stroke: none;
}
.mermaid .loopLine {
stroke-width: 2;
stroke-dasharray: "2 2";
marker-end: "url(#arrowhead)";
stroke: #CCCCFF;
}
.mermaid .note {
stroke: #aaaa33;
fill: #fff5ad;
}
.mermaid .noteText {
fill: black;
stroke: none;
font-family: 'trebuchet ms', verdana, arial;
font-size: 14px;
}
/** Section styling */
.mermaid .section {
stroke: none;
opacity: 0.2;
}
.mermaid .section0 {
fill: rgba(102, 102, 255, 0.49);
}
.mermaid .section2 {
fill: #fff400;
}
.mermaid .section1,
.mermaid .section3 {
fill: white;
opacity: 0.2;
}
.mermaid .sectionTitle0 {
fill: #333;
}
.mermaid .sectionTitle1 {
fill: #333;
}
.mermaid .sectionTitle2 {
fill: #333;
}
.mermaid .sectionTitle3 {
fill: #333;
}
.mermaid .sectionTitle {
text-anchor: start;
font-size: 11px;
text-height: 14px;
}
/* Grid and axis */
.mermaid .grid .tick {
stroke: lightgrey;
opacity: 0.3;
shape-rendering: crispEdges;
}
.mermaid .grid path {
stroke-width: 0;
}
/* Today line */
.mermaid .today {
fill: none;
stroke: red;
stroke-width: 2px;
}
/* Task styling */
/* Default task */
.mermaid .task {
stroke-width: 2;
}
.mermaid .taskText {
text-anchor: middle;
font-size: 11px;
}
.mermaid .taskTextOutsideRight {
fill: black;
text-anchor: start;
font-size: 11px;
}
.mermaid .taskTextOutsideLeft {
fill: black;
text-anchor: end;
font-size: 11px;
}
/* Specific task settings for the sections*/
.mermaid .taskText0,
.mermaid .taskText1,
.mermaid .taskText2,
.mermaid .taskText3 {
fill: white;
}
.mermaid .task0,
.mermaid .task1,
.mermaid .task2,
.mermaid .task3 {
fill: #8a90dd;
stroke: #534fbc;
}
.mermaid .taskTextOutside0,
.mermaid .taskTextOutside2 {
fill: black;
}
.mermaid .taskTextOutside1,
.mermaid .taskTextOutside3 {
fill: black;
}
/* Active task */
.mermaid .active0,
.mermaid .active1,
.mermaid .active2,
.mermaid .active3 {
fill: #bfc7ff;
stroke: #534fbc;
}
.mermaid .activeText0,
.mermaid .activeText1,
.mermaid .activeText2,
.mermaid .activeText3 {
fill: black !important;
}
/* Completed task */
.mermaid .done0,
.mermaid .done1,
.mermaid .done2,
.mermaid .done3 {
stroke: grey;
fill: lightgrey;
stroke-width: 2;
}
.mermaid .doneText0,
.mermaid .doneText1,
.mermaid .doneText2,
.mermaid .doneText3 {
fill: black !important;
}
/* Tasks on the critical line */
.mermaid .crit0,
.mermaid .crit1,
.mermaid .crit2,
.mermaid .crit3 {
stroke: #ff8888;
fill: red;
stroke-width: 2;
}
.mermaid .activeCrit0,
.mermaid .activeCrit1,
.mermaid .activeCrit2,
.mermaid .activeCrit3 {
stroke: #ff8888;
fill: #bfc7ff;
stroke-width: 2;
}
.mermaid .doneCrit0,
.mermaid .doneCrit1,
.mermaid .doneCrit2,
.mermaid .doneCrit3 {
stroke: #ff8888;
fill: lightgrey;
stroke-width: 2;
cursor: pointer;
shape-rendering: crispEdges;
}
.mermaid .doneCritText0,
.mermaid .doneCritText1,
.mermaid .doneCritText2,
.mermaid .doneCritText3 {
fill: black !important;
}
.mermaid .activeCritText0,
.mermaid .activeCritText1,
.mermaid .activeCritText2,
.mermaid .activeCritText3 {
fill: black !important;
}
.mermaid .titleText {
text-anchor: middle;
font-size: 18px;
fill: black;
}
.mermaid g.classGroup text {
fill: #9370DB;
stroke: none;
font-family: 'trebuchet ms', verdana, arial;
font-size: 10px;
}
.mermaid g.classGroup rect {
fill: #ECECFF;
stroke: #9370DB;
}
.mermaid g.classGroup line {
stroke: #9370DB;
stroke-width: 1;
}
.mermaid svg .classLabel .box {
stroke: none;
stroke-width: 0;
fill: #ECECFF;
opacity: 0.5;
}
.mermaid svg .classLabel .label {
fill: #9370DB;
font-size: 10px;
}
.mermaid .relation {
stroke: #9370DB;
stroke-width: 1;
fill: none;
}
.mermaid .composition {
fill: #9370DB;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #compositionStart {
fill: #9370DB;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #compositionEnd {
fill: #9370DB;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid .aggregation {
fill: #ECECFF;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #aggregationStart {
fill: #ECECFF;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #aggregationEnd {
fill: #ECECFF;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #dependencyStart {
fill: #9370DB;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #dependencyEnd {
fill: #9370DB;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #extensionStart {
fill: #9370DB;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid #extensionEnd {
fill: #9370DB;
stroke: #9370DB;
stroke-width: 1;
}
.mermaid .node text {
font-family: 'trebuchet ms', verdana, arial;
font-size: 14px;
}
.mermaid div.mermaidTooltip {
position: absolute;
text-align: center;
max-width: 200px;
padding: 2px;
font-family: 'trebuchet ms', verdana, arial;
font-size: 12px;
background: #ffffde;
border: 1px solid #aaaa33;
border-radius: 2px;
pointer-events: none;
z-index: 100;
}

49
doc/mermaid.min.js vendored Normal file

File diff suppressed because one or more lines are too long

1
doc/src/SUMMARY.md Normal file
View file

@ -0,0 +1 @@
[About](readme.md)

1
doc/src/readme.md Normal file
View file

@ -0,0 +1 @@
Some notes

12
home/index.html Normal file
View file

@ -0,0 +1,12 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Famedly Matrix SDK</title>
</head>
<body>
<a href="api/index.html">API</a>
<a href="doc/index.html">Documentation</a>
</body>
</html>