github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-26 11:43:59 -05:00
Code Issues Projects Releases Packages Wiki Activity
3453 commits 39 branches 47 tags 112 MiB
Commit graph

274 commits

Author SHA1 Message Date
David Mehren
5e771c2f65
Update Content Security Policy docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-06-07 22:57:12 +02:00
Renovate Bot
a3581c514b
chore(deps): update dependency mkdocs-material to v7.1.7 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-06-07 00:17:03 +00:00
Erik Michelson
df7a5e3f6c
Fix link in openapi doc 
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
 2021-06-06 20:33:25 +02:00
Tilman Vatteroth
9a6d5d675a
Remove explicit title from cloudflare warning 
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-06-03 23:24:09 +02:00
Yannick Bungers
23fa44cd36
Merge pull request #1346 from hedgedoc/add-cloudflare-warning-to-docs 
Add Cloudflare warning to the docs
 2021-06-03 20:43:46 +02:00
Tilman Vatteroth
ff12e3b23e
Add Cloudflare warning to the docs 
The cloudflare minify feature for HTML, CSS and JS breaks HedgeDoc.

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
 2021-06-03 17:30:07 +02:00
Renovate Bot
4f592d32e2
chore(deps): update dependency mkdocs-material to v7.1.6 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-31 19:17:51 +00:00
Renovate Bot
b072da418d
chore(deps): update dependency mkdocs-material to v7.1.5 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-19 09:13:36 +00:00
David Mehren
32e31ac1e3
Bump version to 1.8.2 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-11 21:28:10 +02:00
Renovate Bot
1d5cd3cdc9
Update dependency pymdown-extensions to v8.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-08 17:26:14 +00:00
Philip Molares
a4b4ebd80c Docs: Add mention to install devDependencies 
Before `yarn build` can be succesfully run, we need to install the devDependencies.
This is necessary, because `bin/setup` does not install the devDependencies…

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2021-05-08 13:47:31 +02:00
David Mehren
0555d01f4a
Bump version to 1.8.1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-06 22:24:02 +02:00
Renovate Bot
0ec7daf5f7
Update dependency mkdocs-material to v7.1.4 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-05-06 19:09:54 +00:00
David Mehren
e6d4ac5f9a
Remove mention of .sequelizerc from docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-03 22:26:08 +02:00
David Mehren
73e26e1d2d
Bump version to 1.8.0 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-05-03 22:26:08 +02:00
David Mehren
6cccc558e6
Bump version to 1.8.0-rc1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-26 21:42:03 +02:00
Renovate Bot
7d21e12d05
Update dependency mkdocs-material to v7.1.3 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-25 18:35:34 +00:00
David Mehren
2faf5b6974
Merge pull request #1150 from hedgedoc/feature/prometheus_metrics 2021-04-25 20:34:03 +02:00
David Mehren
cbe7b03b59
Document new Prometheus endpoint 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-25 20:06:56 +02:00
David Mehren
e1df30bd5c
Raise minimum required Node.js version to 12 
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>
 2021-04-22 22:52:38 +02:00
Renovate Bot
f697d6699a
Update dependency mkdocs-material to v7.1.2 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-22 15:14:44 +00:00
Philip Molares
7192ec63f3 Docs: Revert changes to manual setup 
This reverts the documentation changes of bf0a7ebee7. 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>
 2021-04-22 13:31:12 +02:00
David Mehren
a15124ba35
Merge pull request #1145 from hedgedoc/docs/darkTheme 
Documentation: Add toggleable dark theme
 2021-04-18 22:50:50 +02:00
Philip Molares
60251d89ee
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>
 2021-04-18 22:44:02 +02:00
Yannick Bungers
58f5282ccb
Merge pull request #984 from hedgedoc/docs/upgrade-instructions 2021-04-17 16:33:49 +02:00
David Mehren
e8465aa8be
Docs: Fixup some wording in manual setup guide 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
c7104c94e4
Docs: Add hint about account creation 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
70a289aeba
Docs: Include minimal config on manual setup page 
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>
 2021-04-16 21:19:13 +02:00
David Mehren
87e0cea2f9
Docs: Cleanup docker page 
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>
 2021-04-16 21:19:13 +02:00
David Mehren
a3ee2c6f8c
Docs: Move migration hints to getting started page 
These are relevant for all installation methods, so they should be
placed at a 'global' place.

Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:19:13 +02:00
David Mehren
2667b642f4
Docs: Include docker-compose snippet 
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>
 2021-04-16 21:19:11 +02:00
David Mehren
c54eef10a6
Add an example systemd unit to installation docs 
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>
 2021-04-16 21:18:35 +02:00
David Mehren
27d53f5233
Remove ancient migration docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2021-04-16 21:18:35 +02:00
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
Renovate Bot
8ad7108f6c
Update dependency mkdocs-material to v7.1.1 
Signed-off-by: Renovate Bot <bot@renovateapp.com>
 2021-04-10 10:35:06 +00: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
aptalca
b9c043bf6b update linuxserver docker info 
Update badges and info to point to the newly published HedgeDoc image

Signed-off-by: aptalca <aptalca@linuxserver.io>
 2020-12-24 17:00:31 -05:00
Philip Molares
a41d9e4c11 Update configuration.md 
Added a more in depth example of how to set CMD_DB_URL or dbUrl

Signed-off-by: Philip Molares <philip.molares@udo.edu>
 2020-12-22 20:32:27 +01:00
ericgaspar
8dc215fd98
Set Install-with-yunohost bagde to SVG 
Signed-off-by: ericgaspar <junk.eg@free.fr>
 2020-12-21 23:28:56 +01:00
David Mehren
faf3010c39
Bump version to 1.7.0 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-21 21:36:40 +01:00
David Mehren
22d2bf00fc
Fix typo in reverse proxy docs 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-13 19:09:41 +01:00
David Mehren
2f5ca84605
Document reverse proxy config for Apache 
As we found out in #616, Apache does not set the `X-Forwarded-Proto` header, which is now required because we switched to secure cookies in 383d791a50.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-13 19:09:34 +01:00
David Mehren
2338a98731
Merge pull request #613 from nidico/patch-1 
Fix some typos in history.md
 2020-12-03 22:18:50 +01:00
David Mehren
81e463250d
Release 1.7.0-rc2 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-12-02 23:15:56 +01:00
Nicolas Dietrich
0195d074a8
Fix some typos in history.md 2020-12-01 00:32:48 +01:00
ericgaspar
d1a0ca05af
Update yunohost.md 
Signed-off-by: ericgaspar <junk.eg@free.fr>

Upgrade YunoHost doc link

Signed-off-by: ericgaspar <junk.eg@free.fr>
 2020-11-30 14:16:10 +01:00
David Mehren
9caaaf48e3
Bump Version to 1.7.0-rc1 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-29 15:59:23 +01:00
David Mehren
a5d835cb74
Merge pull request #597 from hedgedoc/fix/install-docs 2020-11-29 15:51:43 +01:00
David Mehren
c83c6cb226
Document that Git can also be used to checkout releases. 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-27 22:41:54 +01:00
David Mehren
7bcf548cd2
Mention that the database connection string needs an absolute path to the SQLite file 
Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-27 22:41:54 +01:00
David Mehren
b78a58c0a9
Update manual install docs for 1.7 
Starting with 1.7, releases include the frontend bundle.
This commit updates the docs accordingly.

Signed-off-by: David Mehren <git@herrmehren.de>
 2020-11-27 22:41:54 +01:00
David Mehren
61f54db63e
Merge pull request #596 from hedgedoc/remove-pdf-export-code 
Remove pdf export code
 2020-11-27 18:31:19 +01:00