Welcome to the HedgeDoc 2 Documentation¶
🚧⚠️🚧 HedgeDoc 2.0 is still in development!
You are probably looking for the 1.x docs.
Find them in the master branch and on docs.hedgedoc.org.
Welcome to the documentation for HedgeDoc, a collaborative online markdown editor, that you can host yourself.
Quick start¶
- 🦔 New to HedgeDoc? Take the HedgeDoc tour
- 🚀 Want your own instance? Install HedgeDoc yourself
- 🛠️ Want to change something about HedgeDoc? Read the Configuration reference
Getting help¶
Having trouble? We’d like to help!
- ❓ Take a look into the FAQ – there are answers to many common questions.
- 🌐 Still any questions? Ask them at our community forum.
- 💬 Talk to us on our matrix chat.
- 🐛 Report bugs in our issue tracker.
How the documentation is organized¶
To make it easy for you to find the relevant documentation articles, we organized our docs by the following categories:
- Tutorials are detailed step-by-step instructions. Start here if you're new to HedgeDoc, want to create your first presentation or want to build a simple API application.
- How-to guides target the more advanced users and guide them through a variety of topics, addressing non-trivial use-cases. They are more advanced than tutorials and assume some knowledge of HedgeDoc.
- Core concepts explain the internal structure of HedgeDoc by providing background information and explanations. They are especially useful for contributing to HedgeDoc.
- References are details to lookup in a non-guided way. These include for example configuration options or API methods.
Participate in the HedgeDoc project¶
There are different ways how you can participate in the HedgeDoc project:
- Help others or share your experiences and tips in the community forum.
- Improve the translation HegdeDoc of HedgeDoc into your language at our weblate.
- Report bugs, feature requests or enhancement ideas in our issue tracker.
- Read the getting started how-to for developers to start implementing your own features.
