Merge pull request #650 from hedgedoc/mkdocs

docs/dev/documentation.md

@@ -0,0 +1,27 @@
+# Documentation
+
+Our documentation is build with [mkdocs](https://www.mkdocs.org).
+
+## Writing
+
+All documentation files are found in the `docs` directory of the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with nothing special about them.
+
+The config file for mkdocs lies in the root of the repo in a file called `mkdocs.yml`. With that file the theme and menu - amoung others - can be configured.
+**Please note:** Any new files need to be linked to by other files or put in the navigation or the files will be very hard to find on the documentation website.
+
+## Building
+
+To build the documentation locally you need to perform the following steps:
+
+1. make sure you have python3 installed
+2. install all the dependencies possibly with a [venv](https://docs.python.org/3/library/venv.html):  
+`pip install -r mkdocs.requirements.txt`
+3. start the mkdocs dev server `mkdocs serve` or let it build the documentation `mkdocs build`
+
+## Deployment
+
+The documentation is deployed with [Messor Structor](https://github.com/traefik/structor).
+
+The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be found in the [docs.hedgedoc.org repo](https://github.com/hedgedoc/docs.hedgedoc.org). This repo is also used to deploy the actuall website to github.io.
+
+Messor Structor builds and deploys the documentation by finding all branches that follow the pattern `v*` and build each one seperatly via `mkdocs` by first installing `mkdocs.requirements.txt` and then building. Afterwards the menu go template is used to include a version switcher in the theme and make all the different versions available.

docs/dev/getting-started.md

@@ -1,4 +1,4 @@
-# Developer Notes
+# Getting started
 
 ## Preparing for running the code
 

docs/images/favicon.png

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

docs/images/logo.png

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

docs/index.md

@@ -0,0 +1,19 @@
+# Welcome to the HedgeDoc Documentation
+
+![HedgeDoc Logo](images/hedgedoc_logo_horizontal.png)
+
+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