HedgeDoc - Ideas grow better together
Find a file
renovate[bot] eb5c16f9b4 chore(deps): update actions/setup-node action to v3.8.2
Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2023-10-23 15:43:21 +00:00
.github chore(deps): update actions/setup-node action to v3.8.2 2023-10-23 15:43:21 +00:00
.yarn chore(deps): update yarn to v3.6.4 2023-10-04 01:37:24 +00:00
bin fix: macOS compatibility for bin/setup 2023-06-04 20:38:57 +02:00
docs chore(deps): update dependency pymdown-extensions to v10.3.1 2023-10-19 20:30:14 +00:00
lib fix(oauth2): Fix crash in rolesClaim extraction 2023-10-19 19:34:44 +02:00
locales Import translations from POEditor 2023-07-30 20:07:27 +02:00
public Import translations from POEditor 2023-07-30 20:07:27 +02:00
test Fix GitLab snippet export 2022-04-10 21:24:30 +02:00
.babelrc Use esbuild to minify frontend JS 2021-05-06 21:13:56 +02:00
.editorconfig Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
.eslintignore switching to eslint for code checking 2018-11-14 23:15:36 +01:00
.eslintrc.js Cleanup ESLint config 2021-08-14 23:42:26 +02:00
.gitignore Switch to Yarn Berry 2023-06-03 12:09:40 +02:00
.mailmap Update mailmap 2022-04-10 21:49:25 +02:00
.remarkrc fix: override markdown linting preset 2020-07-10 18:57:31 +02:00
.yarnrc.yml chore(deps): update yarn to v3.6.4 2023-10-04 01:37:24 +00:00
app.js enhancement(metrics): allow disabling via config option 2023-06-04 21:03:46 +02:00
app.json fix(heroku): fixed the installation with heroku 2022-05-10 21:49:55 +02:00
AUTHORS Update AUTHORS file 2023-07-30 20:07:27 +02:00
CHANGELOG.md Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
CODE-OF-CONDUCT.md style: linting markdown files 2020-07-10 18:57:59 +02:00
config.json.example Update example config 2021-05-06 22:24:02 +02:00
CONTRIBUTING.md Introduce changelog snippets 2021-08-15 20:11:04 +02:00
LICENSE Replace slogan 2020-11-14 22:23:18 +01:00
package.json chore(deps): update dependency eslint to v8.52.0 2023-10-22 20:40:07 +02:00
README.md chore: update mastodon badge 2022-11-06 21:39:32 +01:00
renovate.json Change label used by renovate to "type: maintenance" 2020-11-30 18:24:43 +01:00
SECURITY.md Replace references to Matrix room with chat.hedgedoc.org 2020-11-27 19:53:26 +01:00
webpack.common.js fix(esbuild): exclude reveal.js marked plugin 2023-06-04 20:31:21 +02:00
webpack.dev.js Don't use eval-based source maps 2021-06-07 23:04:45 +02:00
webpack.htmlexport.js Inline CSS & JS into HTML export template 2021-08-15 00:09:53 +02:00
webpack.prod.js fix(esbuild): exclude reveal.js marked plugin 2023-06-04 20:31:21 +02:00
yarn.lock chore(deps): lock file maintenance 2023-10-23 00:34:36 +00:00

HedgeDoc Logo

HedgeDoc

#HedgeDoc on matrix.org version POEditor Mastodon

HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive it by visiting our HedgeDoc demo server.

It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at HackMD and now forked into its own organisation. A longer writeup can be read in the history.

HedgeDoc 1.7.0 with its feature demonstration page open

Community and Contributions

We welcome contributions! There's a lot to do: If you would like to report bugs, the issue tracker is the right place. If you can help translating, find us on POEditor. To get started developing, take a look at the developer documentation. In any case: come talk to us, we'll be delighted to help you with the first steps.

To stay up to date with our work or get support it's recommended to join our Matrix channel, stop by our community forums or subscribe to the release feed. We also engage in regular community calls (RSS) which you are very welcome to join.

Installation / Upgrading

You can run HedgeDoc in a number of ways, and we created setup instructions for all of these:

Configuration

Theres two main ways to configure your HedgeDoc instance: config file or environment variables. You can choose what works best for you.

HedgeDoc can integrate with

  • facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and oauth2 for login
  • imgur, s3, minio, azure for image/attachment storage (files can also be local!)
  • dropbox for export and import

More info about that can be found in the configuration docs above.

Browser support

To use HedgeDoc, your browser should match or exceed these versions:

  • Chrome Chrome >= 47, Chrome Chrome for Android >= 47
  • Safari Safari >= 10.1, iOS Safari iOS Safari >= 10.3
  • Firefox Firefox >= 44
  • Edge Edge >= 14
  • Opera Opera >= 34, Opera Mini Opera Mini not supported
  • Android Browser Android Browser >= 4.4

Backup/restore your instance

To backup HedgeDoc, you should:

  • backup your database
  • backup your custom config file if you have one
  • backup the upload folder (see the uploadsPath config directive)

Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements.

Our community has created related tools, we'd like to highlight hedgedoc-cli which lets you use HedgeDoc from the comfort of your command line.

License

Licensed under AGPLv3. For our list of contributors, see AUTHORS.

The license does not include the HedgeDoc logo, whose terms of usage can be found in the github repository.