GitHunt
JM

jmallach/hedgedoc

HedgeDoc - The best platform to write and share markdown.

HedgeDoc Logo

#HedgeDoc on matrix.org
version
POEditor
Mastodon
Twitter
REUSE Compliance Check
Nest.JS CI
codecov

HedgeDoc lets you create real-time collaborative markdown notes.

Getting Started

State of the project

HedgeDoc 1.x is stable and used around the world, but the codebase has grown over time,
making it hard to add new features.
We are currently working on HedgeDoc 2, a complete rewrite of HedgeDoc. Please note the following:

  • This branch contains the latest development code and does not implement all features yet.
    If you are looking for the 1.x source code, have a look at the master branch.
  • The 1.x release is maintenance-only. We do not accept feature requests or PRs for this release anymore and may choose
    to close non-critical bug reports, if the bug will be non-existent in 2.0.
  • HedgeDoc 2 will be split in two components. The backend and the frontend. Both are present in this repository.

Development

Information for setting up a local development environment can be found in the developer documentation

HedgeDoc 2 UI Test

Curious about the new look and feel of HedgeDoc 2? We provide a demo of the new UI on hedgedoc.dev. This
version uses mocked data and has no data persistence.

The UI test is hosted by netlify. Please check
their privacy policy as well as ours.

Contributions

We welcome contributions!
Have a look at our contribution docs to find out how you can help. If you want to contribute to
HedgeDoc 2, please join our development chat.

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.

GNU Affero General Public License v3.0
Created March 8, 2023
Updated March 6, 2023