mirror of
https://gitlab.com/famedly/conduit.git
synced 2025-06-27 16:35:59 +00:00
Move some documentation to docs/ and start overhaul
This commit is contained in:
parent
2f4885c2a1
commit
80a2711f45
2 changed files with 29 additions and 15 deletions
|
@ -370,23 +370,17 @@ publish:package:
|
||||||
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file conduit-x86_64-unknown-linux-gnu.deb "${BASE_URL}/conduit-x86_64-unknown-linux-gnu.deb"'
|
- 'curl --header "JOB-TOKEN: $CI_JOB_TOKEN" --upload-file conduit-x86_64-unknown-linux-gnu.deb "${BASE_URL}/conduit-x86_64-unknown-linux-gnu.deb"'
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
pages:
|
pages:
|
||||||
stage: publish
|
stage: "publish"
|
||||||
image: rust
|
image:
|
||||||
variables:
|
name: "squidfunk/mkdocs-material"
|
||||||
CARGO_HOME: $CI_PROJECT_DIR/cargo
|
entrypoint: [""]
|
||||||
before_script:
|
tags: ["docker"]
|
||||||
- export PATH="$PATH:$CARGO_HOME/bin"
|
needs: []
|
||||||
- mdbook --version || cargo install mdbook
|
|
||||||
script:
|
|
||||||
- mdbook build -d public
|
|
||||||
rules:
|
rules:
|
||||||
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
- if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
||||||
|
script:
|
||||||
|
- "mkdocs build --site-dir public"
|
||||||
artifacts:
|
artifacts:
|
||||||
paths:
|
paths:
|
||||||
- public
|
- "public"
|
||||||
cache:
|
|
||||||
key: mdbook_cache
|
|
||||||
paths:
|
|
||||||
- $CARGO_HOME/bin
|
|
||||||
|
|
20
mkdocs.yml
Normal file
20
mkdocs.yml
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
site_name: Conduit Docs
|
||||||
|
site_description: Conduit is a simple, fast and reliable chat server for the Matrix protocol
|
||||||
|
theme:
|
||||||
|
name: material
|
||||||
|
repo_url: https://gitlab.com/famedly/conduit
|
||||||
|
nav:
|
||||||
|
- Home: index.md
|
||||||
|
- Installation:
|
||||||
|
- Prerequisites: installation/prerequisites.md
|
||||||
|
- Distribution Packages: installation/packages.md
|
||||||
|
- Manual: installation/manual.md
|
||||||
|
- Docker: installation/docker.md
|
||||||
|
- Configuration:
|
||||||
|
- Conduit.toml: configuration/conduit.toml.md
|
||||||
|
- Appservices: configuration/appservices.md
|
||||||
|
- Development:
|
||||||
|
- Basics: development/basics.md
|
||||||
|
- Cross compilation: development/cross-compilation.md
|
||||||
|
- Tests & CI: development/tests-ci.md
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue