added all necessary configs to use structor

see https://github.com/traefik/structor

Signed-off-by: Philip Molares <philip.molares@udo.edu>
This commit is contained in:
Philip Molares 2021-01-03 22:15:12 +01:00
parent 55d653a1a2
commit 0911bf96e9
6 changed files with 42 additions and 9 deletions

View file

@ -1,3 +0,0 @@
## Guides
In this section we try to provide you with some step-by-step guides for common scenarios to configure HedgeDoc to your needs.

1
docs/images/favicon.png Symbolic link
View file

@ -0,0 +1 @@
../../public/icons/favicon-32x32.png

1
docs/images/logo.png Symbolic link
View file

@ -0,0 +1 @@
../../public/icons/android-chrome-512x512.png

View file

@ -1,7 +1,19 @@
# Welcome to the HedgeDoc Documentation
This page should help you host and configure your own HedgeDoc instance.
![HedgeDoc Logo](images/hedgedoc_logo_horizontal.png)
We provide:
- [Guides for common scenarios](guides/index.md)
HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive
it by visiting our [HedgeDoc demo server][hedgedoc-demo].
It is inspired by Hackpad, Etherpad and similar collaborative editors. This
project originated with the team at [HackMD](https://hackmd.io) and now forked
into its own organisation. [A longer writeup can be read in the history doc](history.md) or [you can have a look at an explanitory graph over at our website][hedgedoc-history].
If you have any questions that aren't answered here, feel free to ask us on [Matrix][matrix.org-url], stop by our [community forums][hedgedoc-community] or have a look at our [FAQ][hedgedoc-faq].
[hedgedoc-demo]: https://demo.hedgedoc.org
[hedgedoc-history]: https://hedgedoc.org/history
[hedgedoc-faq]: https://hedgedoc.org/faq
[matrix.org-url]: https://chat.hedgedoc.org
[hedgedoc-community]: https://community.hedgedoc.org

3
mkdocs.requirements.txt Normal file
View file

@ -0,0 +1,3 @@
mkdocs==1.1.2
mkdocs-material==6.2.3
pymdown-extensions==8.1

View file

@ -1,8 +1,11 @@
site_name: HedgeDoc
site_url: https://docs.hedgedoc.org
repo_url: https://github.com/hedgedoc/hedgedoc
site_description: 'HedgeDoc Documentation'
site_author: 'HedgeDoc Developers'
nav:
- Home: index.md
- Setup:
- Installation:
- 'Manual Installation': setup/manual-setup.md
- 'Reverse Proxy': setup/reverse-proxy.md
- Docker: setup/docker.md
@ -35,4 +38,20 @@ nav:
- 'Developer Notes': dev/getting-started.md
- 'Operational Transformation': dev/ot.md
- Webpack: dev/webpack.md
theme: readthedocs
- FAQ: https://hedgedoc.org/faq
markdown_extensions:
- toc:
permalink: true
theme:
name: 'material'
language: en
favicon: images/favicon.png
logo: images/logo.png
palette:
scheme: preference
primary: 'red'
accent: 'red'
features:
- navigation.tabs
- navigation.sections
- toc.integrate