Commit graph

190 commits

Author SHA1 Message Date
David Mehren
3eb049e24b
Migrate container docs to main documentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-16 21:18:33 +02:00
David Mehren
1f4388802b
Docs: Improve manual installation guide
- 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>
2021-04-15 21:52:58 +02:00
David Mehren
24dbc23ab0
Docs: Add a note about upgrading to the getting started guide
Signed-off-by: David Mehren <git@herrmehren.de>
2021-04-13 21:46:40 +02:00
Erik Michelson
185c50b25f
Replace codimd.org link with hedgedoc.org
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2021-04-08 21:43:48 +02:00
Yannick Bungers
572affdfb6
Merge pull request #1101 from hedgedoc/add-missing-mkdocs-plugin 2021-04-04 22:09:35 +02:00
Tilman Vatteroth
5218a4f07f
Fix emoji replacement in SAML docs
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-04 16:30:46 +02:00
Tilman Vatteroth
53e3a816b1
Add missing footnote mkdocs extension
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-03 21:15:18 +02:00
Tilman Vatteroth
4a0b00d0a6
Replace Unicode character with emoji shortcode
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-03 21:14:53 +02:00
Tilman Vatteroth
f355cfc864
[Docs] Add "HedgeDoc flavored markdown" page
Co-authored-by: Philip Molares <philip.molares@udo.edu>
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2021-04-01 08:45:29 +02:00
Renovate Bot
53c83003ee
Update dependency mkdocs-material to v7.1.0
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-29 21:04:12 +00:00
Renovate Bot
48568d8ef4
Update dependency mkdocs-material to v7.0.7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-28 14:19:17 +00:00
Renovate Bot
01bcfc499b
Update dependency mkdocs-material to v7.0.6
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-14 14:36:35 +00:00
Renovate Bot
7a6d9752bd
Update dependency mkdocs-material to v7.0.5
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-07 19:03:55 +00:00
David Mehren
bf0a7ebee7
Remove .sequelizerc
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>
2021-03-06 10:34:22 +01:00
Renovate Bot
b70ce530ca
Update dependency mkdocs-material to v7.0.4
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-03-04 19:35:19 +00:00
David Mehren
b47f1e80b4
Add docs about troubleshooting migrations
Signed-off-by: David Mehren <git@herrmehren.de>
2021-03-03 12:38:44 +01:00
Renovate Bot
6798ee9056
Update dependency mkdocs-material to v7.0.3
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-26 16:07:38 +00:00
Renovate Bot
c97530fcf0
Update dependency mkdocs-material to v7
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-25 19:10:35 +00:00
Tilman Vatteroth
ed9e74e68b
Fix link to sequelize database dialect docs
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-09 13:18:54 +01:00
Renovate Bot
4af6a8d302
chore(deps): update dependency pymdown-extensions to v8.1.1
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-05 11:46:59 +00:00
Renovate Bot
6972f19e79
chore(deps): update dependency mkdocs-material to v6.2.8
Signed-off-by: Renovate Bot <bot@renovateapp.com>
2021-02-04 20:47:49 +00:00
Tilman Vatteroth
63b50651df
[Docs] Add "getting started" page
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-03 21:42:49 +01:00
Tilman Vatteroth
dc76d158e7
[Docs] Extend setup page with community methods
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-02-03 20:54:29 +01:00
Nicolas Dietrich
5e269e4af9 Keep JS and env varibale name in sync (requireFreeURLAuthentication)
Signed-off-by: Nicolas Dietrich <nidi@mailbox.org>
2021-01-23 14:14:47 +01:00
Nicolas Dietrich
497569fee4 Add config option which requires authentication in FreeURL mode
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>
2021-01-22 16:52:49 +01:00
Tilman Vatteroth
4d48ef1509
[Documentation] Fix link in manual setup
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-21 21:22:07 +01:00
Tilman Vatteroth
46eda5eead
Rewrite sentence
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-18 16:56:32 +01:00
Tilman Vatteroth
c1d9364a1a
Add page to setup namespace
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-18 16:51:03 +01:00
David Mehren
e9d4587344
Bump version to 1.7.2
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-15 20:37:30 +01:00
David Mehren
eaa7a15615
Docs: Reorder navigation links
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-13 20:59:32 +01:00
David Mehren
c8a7984fa4
Docs: Various formatting fixes
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-13 20:59:32 +01:00
David Mehren
1256eb3cd3
Docs: Use extensions to make markdown parsing more like GFM
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-13 20:59:32 +01:00
David Mehren
512fc2a914
GitLab Auth Guide: Fix indentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:05:31 +01:00
David Mehren
bf7d4ddcd8
GitHub Auth Guide: Fix indentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:04:56 +01:00
David Mehren
ee83c85eb0
SAML Auth Guide: Fix indentation
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:03:48 +01:00
David Mehren
80d8cc79f6
Docs: Unify code block languages
Use `yaml` for Dockerfiles, `shell` for environment variables and `json` for our config file.

Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 12:00:33 +01:00
David Mehren
877bc26078
Docs: Replace :smile with actual 😃 emoji
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 11:54:33 +01:00
David Mehren
1d92a81755
Docs: Enable SuperFences extension
This allows indented code blocks in lists

Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 11:54:33 +01:00
Simon C
6dab69de60
docs: Fix indentation of code
(cherry picked from commit 4559d52d52)
Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-11 11:12:57 +01:00
Tilman Vatteroth
5bdb392413
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>
2021-01-05 22:55:00 +01:00
Tilman Vatteroth
eaeb88401d
Move docs into subdirectory to make mkdocs work in a subdirectory
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2021-01-05 13:15:32 +01:00
David Mehren
fdc86538c6
Merge pull request #650 from hedgedoc/mkdocs 2021-01-04 18:35:08 +01:00
Philip Molares
90371c1c00 added documentation about how the write, build and deploy this
documentation.

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-04 14:26:39 +01:00
David Mehren
9f191bd58f
Merge pull request #646 from hedgedoc/kubernetes 2021-01-04 13:35:24 +01:00
Philip Molares
0911bf96e9 added all necessary configs to use structor
see https://github.com/traefik/structor

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-03 22:15:12 +01:00
Philip Molares
dfa12e52e6 remove old documentation
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-03 16:10:27 +01:00
Philip Molares
55d653a1a2 started work on a mkdocs documentation for readthedocs.org
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-03 16:00:25 +01:00
Philip Molares
d462675fc8 Update docs/setup/kubernetes.md
Co-authored-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-02 16:14:22 +01:00
Philip Molares
d7ef5e83c2 changed kubernetes setup doc
currently we don't provide our own and still linking to hackmd/codimd is
not helpful

Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-01-02 11:01:34 +01:00
David Mehren
7d2c433b1b
Bump version to 1.7.1
Signed-off-by: David Mehren <git@herrmehren.de>
2020-12-27 20:54:39 +01:00