HedgeDoc - Ideas grow better together
Find a file
2020-11-17 13:02:04 +00:00
.github Direct questions to the community forum 2020-11-16 11:54:38 +01:00
bin Correct repo name 2020-11-14 22:24:44 +01:00
docs Rename image file 2020-11-15 20:37:56 +01:00
lib apply review suggestions 2020-11-15 20:12:39 +01:00
locales Remove useless translations 2020-11-15 14:49:56 +01:00
public Fix image width on mobile view for front page 2020-11-16 08:52:56 +01:00
test Add test for dropbox csp rule 2020-08-23 01:41:55 +02:00
.babelrc drop node 6 support 2019-05-13 19:37:21 +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 Add no-console as a warning 2019-05-12 20:15:46 +02:00
.gitignore striving for consistency across various docs 2019-04-01 01:03:36 +02:00
.mailmap Add mailmap for contributors 2018-07-27 13:21:52 +02:00
.remarkrc fix: override markdown linting preset 2020-07-10 18:57:31 +02:00
.sequelizerc.example Create example config 2016-10-05 10:58:05 +08:00
app.js Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
app.json Replace slogan 2020-11-14 22:23:18 +01:00
AUTHORS Fix file permission, remove useless executable 2017-12-14 05:05:18 +08: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 Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
CONTRIBUTING.md Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
LICENSE Replace slogan 2020-11-14 22:23:18 +01:00
package.json Replace slogan 2020-11-14 22:23:18 +01:00
README.md Rename image file 2020-11-15 20:37:56 +01:00
renovate.json Add renovate.json 2020-11-17 13:02:04 +00:00
SECURITY.md Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
webpack.common.js Revert "Adjust webpack config to new code mirror version" 2020-11-11 20:16:47 +01:00
webpack.dev.js Use new source map naming for the Webpack dev config 2020-11-10 22:56:00 +01:00
webpack.htmlexport.js Fix urlPath support, let CodiMD be served from a subpath correctly 2019-12-20 12:03:16 +01:00
webpack.prod.js Fix urlPath support, let CodiMD be served from a subpath correctly 2019-12-20 12:03:16 +01:00
yarn.lock Replace slogan 2020-11-14 22:23:18 +01: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 doc.

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 docs/dev directory. 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 >= 9, iOS Safarai iOS Safari >= 8.4
  • Firefox Firefox >= 44
  • IE IE >= 9, Edge Edge >= 12
  • 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.