4132833b5d
The API documentation belongs strictly to the API itself. Due to the usage of version-prefixed API endpoints, there is no conflict with existing or future endpoints. The reason behind this is that we already have enough exceptions in the routing (default everything to react-frontend, exceptions for backend) and it is hard to keep it synchronized throughout all relevant places. This came to attention as the dev setup didn't proxy the API docs to the backend. Signed-off-by: Erik Michelson <github@erik.michelson.eu> |
||
|---|---|---|
| .github | ||
| .idea/copyright | ||
| .yarn | ||
| backend | ||
| commons | ||
| dev-reverse-proxy | ||
| docker | ||
| docs | ||
| frontend | ||
| html-to-react | ||
| LICENSES | ||
| markdown-it-plugins | ||
| .dockerignore | ||
| .env.example | ||
| .env.example.license | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .mailmap.license | ||
| .nvmrc | ||
| .nvmrc.license | ||
| .yarnrc.yml | ||
| AUTHORS | ||
| CODE_OF_CONDUCT.md | ||
| codecov.yml | ||
| CONTRIBUTING.md | ||
| developer-certificate-of-origin.txt | ||
| developer-certificate-of-origin.txt.license | ||
| LICENSE | ||
| package.json | ||
| package.json.license | ||
| README.md | ||
| renovate.json | ||
| renovate.json.license | ||
| REUSE.toml | ||
| SECURITY.md | ||
| turbo.json | ||
| turbo.json.license | ||
| yarn.lock | ||
| yarn.lock.license | ||
HedgeDoc lets you create real-time collaborative markdown notes.
Getting Started
- ℹ️ Read all about HedgeDoc and the history of the project on our website
- 🧪 Try out HedgeDoc with the demo instance. Check out the features page!
- 💽 Install HedgeDoc yourself using the install guide
- ❓ Questions? Join our Matrix chat or the community forums
- 💬 Stay up to date by subscribing to the release feed
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 Alpha
Curious about the new look and feel of HedgeDoc 2? We provide a demo of the alpha on hedgedoc.dev.
If you want to try it out on your own devices, visit the HedgeDoc 2 docs. But be aware that these may change over time.
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.