Commit graph

233 commits

Author SHA1 Message Date
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
Yannick Bungers
8f7e11f780
Merge pull request #595 from joachimmathes/oauth2_authorization
Add oauth2 authorization roles
2020-11-27 09:09:29 +01:00
Tilman Vatteroth
97312b5ed3
Remove pdf export code
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-26 21:09:23 +01:00
Joachim Mathes
729b387536 Add oauth2 authorization
Signed-off-by: Joachim Mathes <joachim_mathes@web.de>
2020-11-25 19:23:55 +01:00
Nils VAN ZUIJLEN
3449a85e4d
Replace nGinx by Nginx
Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
2020-11-18 18:39:31 +01:00
Nils VAN ZUIJLEN
379cff97d9
Add documentation for reverse-proxy use
Fixes #256

Signed-off-by: Nils VAN ZUIJLEN <nils.van-zuijlen@mailo.com>
2020-11-18 16:29:18 +01:00
Erik Michelson
938d39495f
Updated screenshot
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-11-17 11:13:58 +01:00
Tilman Vatteroth
9898ab3ca5
Rename image file 2020-11-15 20:37:56 +01:00
Tilman Vatteroth
f37d890c65
Replace hedgedoc logo with horizontal 2020-11-15 20:37:01 +01:00
Tilman Vatteroth
243046e620
Rename image 2020-11-15 20:35:05 +01:00
Tilman Vatteroth
ad15c607db
Resize hedgedoc logo for readme 2020-11-15 20:33:15 +01:00
Tilman Vatteroth
b600f7fb4a
Resize readme image 2020-11-15 20:30:46 +01:00
Tilman Vatteroth
762376b925
Replace image in readme 2020-11-15 20:29:44 +01:00
Tilman Vatteroth
4688eec853
change images in docs auth github 2020-11-15 20:24:05 +01:00
mrdrogdrog
d10c13e842
Update docs/configuration.md
Co-authored-by: Erik Michelson <github@erik.michelson.eu>
2020-11-15 20:03:09 +01:00
mrdrogdrog
2e3d915927
Update docs/setup/docker.md
Co-authored-by: Philip Molares <git@molar.es>
2020-11-15 13:19:59 +01:00
mrdrogdrog
5aeec761e2
Update docs/setup/docker.md
Co-authored-by: Philip Molares <git@molar.es>
2020-11-15 13:19:50 +01:00
mrdrogdrog
03795cbf7b
Update docs/guides/auth/keycloak.md
Co-authored-by: Philip Molares <git@molar.es>
2020-11-15 13:19:39 +01:00
Sheogorath
d2e4afb77e
Update history.md 2020-11-15 12:46:19 +01:00
mrdrogdrog
8b8f8b4582
Update docs/guides/migrations-and-breaking-changes.md
Co-authored-by: Philip Molares <git@molar.es>
2020-11-15 12:34:08 +01:00
Tilman Vatteroth
0c6a420e75
Reword history text
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-14 23:14:01 +01:00
Tilman Vatteroth
c3fccfc385
Insert history text
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-14 22:37:42 +01:00
Tilman Vatteroth
1d91979540
Revert incomplete text
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-14 22:26:25 +01:00
Tilman Vatteroth
978538c0de
Correct repo name
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-14 22:24:44 +01:00
Tilman Vatteroth
2fffe04b01
Replace screenshot in readme
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
2020-11-14 21:59:15 +01:00
Erik Michelson
b28839484d
Replace CodiMD with HedgeDoc
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in public/views

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in README

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in SECURITY.md

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in LICENSE

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in docs/configuration.md

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in bin/setup

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/guides

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/dev

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/guides/auth

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/setup

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update various links in code to the new GitHub org.

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: codiMDVersion.js is now hedgeDocVersion.js

Signed-off-by: David Mehren <git@herrmehren.de>
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: References in docs/setup/yunohost

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rebrand to HedgeDoc: Add banner and logo

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Update links in docs/guides/migrate-etherpad

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Remove note in docs/guides/auth/github

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Replace links in public/docs/features

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Add todo placeholder in docs/history

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Replace github link in public/views/index/body

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Replace github link in README

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Add logo to README

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Rename to HedgeDoc: Add note about the renaming to the front page

Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>

Removed Travis from README.md and change CodiMD to HedgeDoc in some places

Signed-off-by: Yannick Bungers <git@innay.de>

Some more renaming to HedgeDoc
- Fixed capitalization of HedgeDoc
- Added renaming for etherpad migration doc

Signed-off-by: Yannick Bungers <git@innay.de>

Changed Repo name to hedgedoc

Signed-off-by: Yannick Bungers <git@innay.de>
2020-11-14 21:18:36 +01:00
David Mehren
299301f0fe
Merge pull request #567 from codimd/fix/manual-setup-doc
Fixed inconsistencies in documentation
2020-11-13 17:18:32 +01:00
David Mehren
7560943a44
Merge pull request #499 from pierreozoux/convenience-script
Adds convenience script to migrate to minio.
2020-11-13 17:17:17 +01:00
pierreozoux
47427a1b88 Adds convenience script to migrate to minio.
Signed-off-by: pierreozoux <pierre@ozoux.net>
2020-11-12 21:14:27 +01:00
Yannick Bungers
4c410ee416 Fixed inconsistencies in documentation
- Updated Node.js requirement
- Added warning for older Mysql and MariaDB versions
- changed npm commands to yarn commands
- changed occurrences of CodiMD to HedgeDoc for easier merging

Signed-off-by: Yannick Bungers <git@innay.de>
2020-11-12 19:54:32 +01:00
Éric Gaspar
72cb67883c
Update configuration.md
Minor formatting typo

Signed-off-by: ericgaspar <junk.eg@free.fr>
2020-10-11 13:43:40 +02:00
Erik Michelson
4ece86f0ef
Update documentation and messages to new default value
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-09-08 09:58:15 +02:00
Erik Michelson
824f910bfe
Add config option for cookie SameSite policy
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2020-08-27 02:04:49 +02:00
oupala
260e9b8958 feat: add default values to configuration documentation
Add default values to configuration documentation when a default value is hard-coded. Specify **no default** otherwise.

Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-08-04 19:03:42 +02:00
Leo Maroni
35ec617007
Fixed Image Sources in saml-keycloak guide
Signed-off-by: Leo Maroni <git@em0lar.de>
2020-07-11 21:20:59 +02:00
Leo Maroni
ae8bb96cc6
Create Keycloak SAML guide
Co-authored-by: Simeon Keske <git@n0emis.eu>
Signed-off-by: Simeon Keske <git@n0emis.eu>
Signed-off-by: Leo Maroni <git@em0lar.de>
2020-07-11 21:20:53 +02:00
Simeon Keske
17f0067ab2
allow to set a saml client certificate
Signed-off-by: Simeon Keske <git@n0emis.eu>
2020-07-11 21:19:49 +02:00
David Mehren
3db8b0df43
Merge pull request #410 from oupala/feature/markdown-linting 2020-07-10 19:59:32 +02:00
oupala
2f462f90d4 style: linting markdown files
Linting markdown files according to default remark-lint configuration.

Files inside the `public` directory were not linted.

Signed-off-by: oupala <oupala@users.noreply.github.com>
2020-07-10 18:57:59 +02:00
ericgaspar
91582ea722
Create yunohost.md
Signed-off-by: ericgaspar <junk.eg@free.fr>

Add setup doc about deploying CodiMD with YunoHost.
2020-07-02 21:31:47 +02:00
Victor Berger
5f3a1b6266 Backport of #278 for 1.6.1
This is a backport of #278 with the default value of `scope` changed to
`undefined`. This is thus a fully backward-compatible change.

Signed-off-by: Victor Berger <victor.berger@m4x.org>
2020-06-20 16:48:25 +02:00
Sheogorath
0ef5261e61
Merge pull request #398 from gramakri/patch-1
Update Cloudron docs
2020-06-20 14:58:05 +02:00