diff options
| -rw-r--r-- | docs/guides/index.md | 3 | ||||
| l--------- | docs/images/favicon.png | 1 | ||||
| l--------- | docs/images/logo.png | 1 | ||||
| -rw-r--r-- | docs/index.md | 20 | ||||
| -rw-r--r-- | mkdocs.requirements.txt | 3 | ||||
| -rw-r--r-- | mkdocs.yml | 23 |
6 files changed, 42 insertions, 9 deletions
diff --git a/docs/guides/index.md b/docs/guides/index.md deleted file mode 100644 index 25d4d949..00000000 --- a/docs/guides/index.md +++ /dev/null @@ -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. diff --git a/docs/images/favicon.png b/docs/images/favicon.png new file mode 120000 index 00000000..2b0c8015 --- /dev/null +++ b/docs/images/favicon.png @@ -0,0 +1 @@ +../../public/icons/favicon-32x32.png
\ No newline at end of file diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 120000 index 00000000..22e855a9 --- /dev/null +++ b/docs/images/logo.png @@ -0,0 +1 @@ +../../public/icons/android-chrome-512x512.png
\ No newline at end of file diff --git a/docs/index.md b/docs/index.md index e00a1d10..fb6f2cb8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,19 @@ # 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) - +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
\ No newline at end of file diff --git a/mkdocs.requirements.txt b/mkdocs.requirements.txt new file mode 100644 index 00000000..57d08e48 --- /dev/null +++ b/mkdocs.requirements.txt @@ -0,0 +1,3 @@ +mkdocs==1.1.2 +mkdocs-material==6.2.3 +pymdown-extensions==8.1 @@ -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 |
