mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-25 19:26:31 -05:00
started work on a mkdocs documentation for readthedocs.org
Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
parent
5b3d62e494
commit
55d653a1a2
3 changed files with 48 additions and 0 deletions
3
docs/guides/index.md
Normal file
3
docs/guides/index.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
## Guides
|
||||||
|
|
||||||
|
In this section we try to provide you with some step-by-step guides for common scenarios to configure HedgeDoc to your needs.
|
7
docs/index.md
Normal file
7
docs/index.md
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
# Welcome to the HedgeDoc Documentation
|
||||||
|
|
||||||
|
This page should help you host and configure your own HedgeDoc instance.
|
||||||
|
|
||||||
|
We provide:
|
||||||
|
- [Guides for common scenarios](guides/index.md)
|
||||||
|
|
38
mkdocs.yml
Normal file
38
mkdocs.yml
Normal file
|
@ -0,0 +1,38 @@
|
||||||
|
site_name: HedgeDoc
|
||||||
|
site_url: https://docs.hedgedoc.org
|
||||||
|
nav:
|
||||||
|
- Home: index.md
|
||||||
|
- Setup:
|
||||||
|
- 'Manual Installation': setup/manual-setup.md
|
||||||
|
- 'Reverse Proxy': setup/reverse-proxy.md
|
||||||
|
- Docker: setup/docker.md
|
||||||
|
- Kubernetes: setup/kubernetes.md
|
||||||
|
- Cloudron: setup/cloudron.md
|
||||||
|
- Heroku: setup/heroku.md
|
||||||
|
- LinuxServer: setup/docker-linuxserver.md
|
||||||
|
- Yunohost: setup/yunohost.md
|
||||||
|
- Guides:
|
||||||
|
- Authentication:
|
||||||
|
- LDAP: guides/auth/ldap-ad.md
|
||||||
|
- OAuth: guides/auth/oauth.md
|
||||||
|
- SAML : guides/auth/saml.md
|
||||||
|
- SAML Keycloak : guides/auth/saml-keycloak.md
|
||||||
|
- SAML Onelogin : guides/auth/saml-onelogin.md
|
||||||
|
- GitHub: guides/auth/github.md
|
||||||
|
- GitLab: guides/auth/gitlab-self-hosted.md
|
||||||
|
- Keycloak: guides/auth/keycloak.md
|
||||||
|
- NextCloud: guides/auth/nextcloud.md
|
||||||
|
- Twitter: guides/auth/twitter.md
|
||||||
|
- Migrate from Etherpad: guides/migrate-etherpad.md
|
||||||
|
- Breaking Changes: guides/migrations-and-breaking-changes.md
|
||||||
|
- Media Backend:
|
||||||
|
- Minion: guides/minio-image-upload.md
|
||||||
|
- S3: guides/s3-image-upload.md
|
||||||
|
- Setting Terms: guides/providing-terms.md
|
||||||
|
- Configuration: configuration.md
|
||||||
|
- Developer:
|
||||||
|
- API: dev/api.md
|
||||||
|
- 'Developer Notes': dev/getting-started.md
|
||||||
|
- 'Operational Transformation': dev/ot.md
|
||||||
|
- Webpack: dev/webpack.md
|
||||||
|
theme: readthedocs
|
Loading…
Reference in a new issue