summaryrefslogtreecommitdiff
path: root/docs/content (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #1150 from hedgedoc/feature/prometheus_metricsDavid Mehren2021-04-251-3/+4
|\
| * Document new Prometheus endpointDavid Mehren2021-04-251-3/+4
| | | | | | | | Signed-off-by: David Mehren <git@herrmehren.de>
* | Raise minimum required Node.js version to 12David Mehren2021-04-221-1/+1
|/ | | | | | | | | As Node 10 will be EOL at April 30th, we should stop supporting and/or promoting the usage of that version. See also https://endoflife.date/nodejs Signed-off-by: David Mehren <git@herrmehren.de>
* Docs: Revert changes to manual setupPhilip Molares2021-04-221-3/+7
| | | | | | This reverts the documentation changes of bf0a7ebee72404eb7bce918f41162126bca24bf0. This is necessary as the omitted remarks about `.sequlizerc` can't be omitted until 1.8 is released. Signed-off-by: Philip Molares <philip.molares@udo.edu>
* Merge pull request #1145 from hedgedoc/docs/darkThemeDavid Mehren2021-04-186-8/+50
|\ | | | | Documentation: Add toggleable dark theme
| * Documentation: Add toggleable dark themePhilip Molares2021-04-186-8/+50
| | | | | | | | | | | | | | 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>
* | Docs: Fixup some wording in manual setup guideDavid Mehren2021-04-161-4/+4
| | | | | | | | Signed-off-by: David Mehren <git@herrmehren.de>
* | Docs: Add hint about account creationDavid Mehren2021-04-161-0/+2
| | | | | | | | Signed-off-by: David Mehren <git@herrmehren.de>
* | Docs: Include minimal config on manual setup pageDavid Mehren2021-04-161-2/+16
| | | | | | | | | | | | | | To make it easier to get started, this commit adds a minimal `config.json` snipped to the manual setup instruction. Signed-off-by: David Mehren <git@herrmehren.de>
* | Docs: Cleanup docker pageDavid Mehren2021-04-161-20/+0
| | | | | | | | | | | | | | | | Build instructions are not relevant for most users. Contact info can already be found on the 'Home' page. Signed-off-by: David Mehren <git@herrmehren.de>
* | Docs: Move migration hints to getting started pageDavid Mehren2021-04-162-17/+13
| | | | | | | | | | | | | | These are relevant for all installation methods, so they should be placed at a 'global' place. Signed-off-by: David Mehren <git@herrmehren.de>
* | Docs: Include docker-compose snippetDavid Mehren2021-04-161-15/+37
| | | | | | | | | | | | | | | | | | | | | | | | Directing users to use the container repo to install HedgeDoc has caused upgrade-trouble in the past, after we made incompatible changes to the docker-compose.yml in the repo. This commit inserts a minimal docker-compose snipped in the docs, which can be used to get started. Upgrading can then be performed by just incrementing the referenced image version. Signed-off-by: David Mehren <git@herrmehren.de>
* | Add an example systemd unit to installation docsDavid Mehren2021-04-161-1/+69
| | | | | | | | | | | | | | | | | | Heavily inspired by the unit of Arch Linux: https://github.com/archlinux/svntogit-community/blob/packages/hedgedoc/trunk/hedgedoc.service Fixes https://github.com/hedgedoc/hedgedoc/issues/46 Signed-off-by: David Mehren <git@herrmehren.de>
* | Remove ancient migration docsDavid Mehren2021-04-161-55/+0
| | | | | | | | Signed-off-by: David Mehren <git@herrmehren.de>
* | Migrate container docs to main documentationDavid Mehren2021-04-161-10/+95
| | | | | | | | Signed-off-by: David Mehren <git@herrmehren.de>
* | Docs: Improve manual installation guideDavid Mehren2021-04-151-31/+45
| | | | | | | | | | | | | | | | | | | | | | - Move the requirements into an info block - Make clear that we use Yarn Classic - Link to our downloads page instead of GitHub - Simplify paragraph about configuring HedgeDoc - Move additional information into `<small>` tags - Match upgrade documentation to installation steps. Signed-off-by: David Mehren <git@herrmehren.de>
* | Docs: Add a note about upgrading to the getting started guideDavid Mehren2021-04-131-0/+11
|/ | | | Signed-off-by: David Mehren <git@herrmehren.de>
* Replace codimd.org link with hedgedoc.orgErik Michelson2021-04-081-1/+1
| | | | Signed-off-by: Erik Michelson <github@erik.michelson.eu>
* Merge pull request #1101 from hedgedoc/add-missing-mkdocs-pluginYannick Bungers2021-04-041-50/+50
|\
| * Replace Unicode character with emoji shortcodeTilman Vatteroth2021-04-031-50/+50
| | | | | | | | Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
* | Fix emoji replacement in SAML docsTilman Vatteroth2021-04-041-2/+2
|/ | | | Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
* [Docs] Add "HedgeDoc flavored markdown" pageTilman Vatteroth2021-04-011-0/+116
| | | | | Co-authored-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
* Remove .sequelizercDavid Mehren2021-03-061-6/+2
| | | | | | | | After https://github.com/hedgedoc/hedgedoc/pull/969 was merged, a separate configuration file for the sequelize-cli is no longer required. Signed-off-by: David Mehren <git@herrmehren.de>
* Add docs about troubleshooting migrationsDavid Mehren2021-03-031-0/+25
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* Fix link to sequelize database dialect docsTilman Vatteroth2021-02-091-15/+15
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* [Docs] Add "getting started" pageTilman Vatteroth2021-02-032-9/+28
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* [Docs] Extend setup page with community methodsTilman Vatteroth2021-02-035-13/+12
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* Keep JS and env varibale name in sync (requireFreeURLAuthentication)Nicolas Dietrich2021-01-231-1/+1
| | | | Signed-off-by: Nicolas Dietrich <nidi@mailbox.org>
* Add config option which requires authentication in FreeURL modeNicolas Dietrich2021-01-221-0/+1
| | | | | | | | | This mitigates unintended note creation by bots or humans through a simple GET call. See discussion in #754. Signed-off-by: Nicolas Dietrich <nidi@mailbox.org>
* [Documentation] Fix link in manual setupTilman Vatteroth2021-01-211-1/+1
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* Rewrite sentenceTilman Vatteroth2021-01-181-1/+1
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* Add page to setup namespaceTilman Vatteroth2021-01-181-0/+8
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* Bump version to 1.7.2David Mehren2021-01-152-2/+2
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* Docs: Various formatting fixesDavid Mehren2021-01-135-8/+11
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* GitLab Auth Guide: Fix indentationDavid Mehren2021-01-111-12/+13
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* SAML Auth Guide: Fix indentationDavid Mehren2021-01-111-10/+15
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* Docs: Unify code block languagesDavid Mehren2021-01-1110-20/+20
| | | | | | Use `yaml` for Dockerfiles, `shell` for environment variables and `json` for our config file. Signed-off-by: David Mehren <git@herrmehren.de>
* Docs: Replace `:smile` with actual 😃 emojiDavid Mehren2021-01-116-8/+9
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* docs: Fix indentation of codeSimon C2021-01-111-23/+32
| | | | | (cherry picked from commit 4559d52d521939739b0d3aad0c84e39d2aa5c960) Signed-off-by: David Mehren <git@herrmehren.de>
* Several theme changes (#659)Tilman Vatteroth2021-01-056-0/+31
| | | | | | | | | | * 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>
* Move docs into subdirectory to make mkdocs work in a subdirectoryTilman Vatteroth2021-01-0586-0/+2393
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>