summaryrefslogtreecommitdiff
path: root/docs (follow)
Commit message (Collapse)AuthorAgeFilesLines
* 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-187-11/+65
|\ | | | | Documentation: Add toggleable dark theme
| * Documentation: Add toggleable dark themePhilip Molares2021-04-187-11/+65
| | | | | | | | | | | | | | 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>
* | Merge pull request #984 from hedgedoc/docs/upgrade-instructionsYannick Bungers2021-04-175-104/+241
|\ \ | |/ |/|
| * 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-162-56/+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-132-0/+12
| | | | | | | | Signed-off-by: David Mehren <git@herrmehren.de>
* | Update dependency mkdocs-material to v7.1.1Renovate Bot2021-04-101-1/+1
|/ | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* 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-042-50/+51
|\
| * Add missing footnote mkdocs extensionTilman Vatteroth2021-04-031-0/+1
| | | | | | | | Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
| * 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-012-0/+118
| | | | | Co-authored-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
* Update dependency mkdocs-material to v7.1.0Renovate Bot2021-03-291-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* Update dependency mkdocs-material to v7.0.7Renovate Bot2021-03-281-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* Update dependency mkdocs-material to v7.0.6Renovate Bot2021-03-141-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* Update dependency mkdocs-material to v7.0.5Renovate Bot2021-03-071-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* 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>
* Update dependency mkdocs-material to v7.0.4Renovate Bot2021-03-041-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* Add docs about troubleshooting migrationsDavid Mehren2021-03-032-0/+26
| | | | Signed-off-by: David Mehren <git@herrmehren.de>
* Update dependency mkdocs-material to v7.0.3Renovate Bot2021-02-261-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* Update dependency mkdocs-material to v7Renovate Bot2021-02-251-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* Fix link to sequelize database dialect docsTilman Vatteroth2021-02-091-15/+15
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* chore(deps): update dependency pymdown-extensions to v8.1.1Renovate Bot2021-02-051-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* chore(deps): update dependency mkdocs-material to v6.2.8Renovate Bot2021-02-041-1/+1
| | | | Signed-off-by: Renovate Bot <bot@renovateapp.com>
* [Docs] Add "getting started" pageTilman Vatteroth2021-02-033-9/+33
| | | | Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
* [Docs] Extend setup page with community methodsTilman Vatteroth2021-02-036-20/+23
| | | | 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: Reorder navigation linksDavid Mehren2021-01-131-6/+6
| | | | 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>
* Docs: Use extensions to make markdown parsing more like GFMDavid Mehren2021-01-132-0/+3
| | | | 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>
* GitHub Auth Guide: Fix indentationDavid Mehren2021-01-111-2/+2
| | | | 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>
generated by cgit v1.2.3 (git 2.25.1) at 2024-12-23 07:00:49 +0000