mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2025-05-09 13:51:57 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
hedgedoc/docs/content/index.md
Erik Michelson 70a6583fe0
docs: restructure
2025-04-15 23:22:00 +02:00

4 KiB
Raw Blame History

Welcome to the HedgeDoc 2 Documentation

HedgeDoc Logo HedgeDoc Logo

!!! danger "🚧⚠️🚧 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

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:

  • Getting started: This section contains tutorials for people who are new to HedgeDoc. Start here to learn how to create your first note or presentation, how to manage your notes or even how to setup your own instance.
  • How-to guides: This section targets the more advanced users. It guides you through a variety of topics, addressing non-trivial use-cases. The guides are more advanced than tutorials and assume some knowledge of HedgeDoc.
  • Configuration: All configuration options are explained in this section. Use it as a reference when setting up your own instance or explore the possibilities what can be configured.
  • Development: This section contains explanations of the core concepts behind the architecture of HedgeDoc as well as guides to set up the development environment for ontributing to the codebase. Use this section as a starting point if you intend to contribute code-wise to HedgeDoc.
  • References: This section contains information that is useful to look up in a non-guided way. This includes for example the supported Markdown features or the API endpoints.

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 of HedgeDoc into your language at our translation tool.
  • Report bugs, feature requests or enhancement ideas in our issue tracker.
  • Read the development section of the docs to setup your local dev environment and start implementing your own features.

Deployed using netlify