Philip Molares
e07cd62596
docs: restructure documentation
...
This rewrite follows the principles of https://diataxis.fr/
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-09-17 21:50:21 +02:00
David Mehren
520d0933cb
docs: add getting started guide
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-25 13:05:42 +01:00
David Mehren
b5e64880cd
docs: Add docker docs to navbar
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
c278f6d78b
docs: Split up 2.0.md and rename to dev_notes.md
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
bec48f3c22
docs: Add frontend docs to navbar
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
3c957e9b0e
docs: Move 'Events' to design docs
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
58f306a38c
docs: Merge API Authentication docs
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
1093da4a39
docs: Move 'Notes' to design docs
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
c9f8285f57
docs: Move 'Configuration' to design docs
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
162a8e8816
docs: Move 'User Profiles & Authentication' to design docs
...
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
David Mehren
8bb39b8c6d
docs: introduce 'Design Documents' category
...
These documents provide context for various application aspects.
This commit also fixes the indentation and missing lists in the mkdocs config.
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-24 20:06:11 +01:00
Philip Molares
9c2e47dcc4
Docs: Add configuration documentation
...
This adds documentation for the configuration of HedgeDoc.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-25 17:29:53 +02:00
Philip Molares
67e1ff3d07
Documentation: Add toggleable dark theme
...
The dark theme is mostly built on top of the mkdocs slate theme.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
Co-Authored-by: Tilman Vatteroth <git@tilmanvatteroth.de>
(cherry picked from commit 60251d89ee
2021-04-17 12:42:03 +02:00
Philip Molares
157d9bb21c
Add dev docs about notes
...
fixes #864
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-18 13:49:25 +01:00
Philip Molares
f78b857aef
Docs: Add footnotes extension
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-28 20:24:45 +02:00
Philip Molares
c272f1e702
Docs: Add hedgedoc flavored markdown reference
...
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-25 22:20:45 +01:00
David Mehren
2d05f0cd77
Add dev docs about user profiles and authentication
...
Closes #463
Closes #451
Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-15 11:19:50 +01:00
Philip Molares
8a33f75cf9
Docs: Add interface documentation for the toolbar
...
This documentation explains HedgeDoc's toolbar to new users.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-10 21:51:08 +01:00
Philip Molares
07dc15b127
Dev Docs: Add configuration to navigation
...
This makes it possible to access the developer documentation about configuration code.
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-02-03 20:58:16 +01:00
David Mehren
2ee8ff4d91
Update docs with hint about 2.0 development
...
Replace the old docs index page with a hint where the (for now) 'real'
docs can be found and that HedgeDoc 2.0 is still in development.
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 21:50:38 +01:00
David Mehren
effba43fe8
Delete old docs not relevant for 2.x
...
Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 16:14:59 +01:00
Tilman Vatteroth
e4080b7ead
Several theme changes ( #659 )
...
* Several theme changes
- Add max width of 1440px
- Rename css file
- Fix edit button
- Add local Roboto font
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
(cherry picked from commit 5bdb392413
2021-01-05 22:55:00 +01:00
Tilman Vatteroth
b386737d08
Move docs into subdirectory to make mkdocs work in a subdirectory
...
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
(cherry picked from commit eaeb88401d
2021-01-04 13:07:44 +01:00
