2021-01-05 16:12:38 -05:00
<!--
2021-01-06 15:36:07 -05:00
SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
2021-01-05 16:12:38 -05:00
SPDX-License-Identifier: CC-BY-SA-4.0
-->
2021-04-25 17:03:33 -04:00
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[![#HedgeDoc on matrix.org][matrix.org-image]][matrix.org-url]
2022-01-23 15:18:08 -05:00
[![version][github-version-badge]][github-release-page]
[![POEditor][poeditor-image]][poeditor-url]
[![Mastodon][social-mastodon-image]][social-mastodon]
2021-01-06 06:55:40 -05:00
![REUSE Compliance Check][reuse-workflow-badge]
![Nest.JS CI][nestjs-workflow-badge]
[![codecov][codecov-badge]][codecov-url]
2022-01-23 15:18:08 -05:00
2021-04-16 13:22:50 -04:00
HedgeDoc lets you create real-time collaborative markdown notes.
2022-01-23 15:18:08 -05:00
2021-04-16 13:22:50 -04:00
## Getting Started
- ℹ ️ our website ](https://hedgedoc.org )
- 🧪 Try out HedgeDoc with the [demo instance][hedgedoc-demo]. Check out the [features page][hedgedoc-demo-features]!
- 💽 Install HedgeDoc yourself using the [install guide ](https://docs.hedgedoc.org/setup/getting-started/ )
- ❓ Questions? Join our [Matrix chat][matrix.org-url] or the [community forums][hedgedoc-community]
- 💬 Stay up to date by subscribing to the [release feed][github-release-feed]
2022-01-23 15:18:08 -05:00
2021-04-16 13:22:50 -04:00
## State of the project
2021-04-17 09:17:44 -04:00
HedgeDoc 1.x is stable and used around the world, but the codebase has [grown over time ](https://hedgedoc.org/history/ ),
making it hard to add new features.
2021-04-16 13:22:50 -04:00
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](https://github.com/hedgedoc/hedgedoc/tree/master).**
2021-01-04 08:54:19 -05:00
- 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.
2022-11-11 05:27:05 -05:00
- HedgeDoc 2 will be split in two components. The backend and the frontend. Both are present in this repository.
2022-01-23 15:18:08 -05:00
2022-11-11 05:27:05 -05:00
## Development
2024-01-11 19:22:00 -05:00
Information for setting up a local development environment can be found in the [developer documentation ](https://docs.hedgedoc.dev/how-to/develop/setup/ )
2022-11-11 05:27:05 -05:00
2023-10-08 13:39:28 -04:00
## HedgeDoc 2 Alpha
Curious about the new look and feel of HedgeDoc 2? We provide a demo of the alpha on [hedgedoc.dev ](https://hedgedoc.dev ).
2022-01-23 15:18:08 -05:00
2023-10-08 15:17:28 -04:00
If you want to try it out on your own devices, visit the [HedgeDoc 2 docs ](https://docs.hedgedoc.dev ).
But be aware that these may change over time.
2021-04-16 13:22:50 -04:00
## Contributions
2022-01-23 15:18:08 -05:00
2021-04-16 12:43:28 -04:00
We welcome contributions!
Have a look at our [contribution docs ](CONTRIBUTING.md ) to find out how you can help. If you want to contribute to
HedgeDoc 2, please join our [development chat][matrix.org-dev-url].
2021-01-04 08:54:19 -05:00
# License
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
Licensed under AGPLv3. For our list of contributors, see [AUTHORS ](AUTHORS ).
2022-01-23 15:18:08 -05:00
2021-01-04 07:07:44 -05:00
The license does not include the HedgeDoc logo, whose terms of usage can be found in
the [github repository ](https://github.com/hedgedoc/hedgedoc-logo ).
2021-01-04 08:54:19 -05:00
[matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix& server_fqdn=matrix.org
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[matrix.org-url]: https://chat.hedgedoc.org
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[matrix.org-dev-url]: https://chat.hedgedoc.org/dev
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[github-version-badge]: https://img.shields.io/github/release/hedgedoc/hedgedoc.svg
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[github-release-page]: https://github.com/hedgedoc/hedgedoc/releases
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[github-release-feed]: https://github.com/hedgedoc/hedgedoc/releases.atom
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[github-issue-tracker]: https://github.com/hedgedoc/hedgedoc/issues/
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg
2022-01-23 15:18:08 -05:00
2021-01-04 08:54:19 -05:00
[poeditor-url]: https://poeditor.com/join/project/1OpGjF2Jir
2021-01-06 06:55:40 -05:00
2021-09-05 05:52:12 -04:00
[hedgedoc-demo]: https://hedgedoc.org/demo/
2021-01-06 06:55:40 -05:00
2021-01-04 08:54:19 -05:00
[hedgedoc-demo-features]: https://demo.hedgedoc.org/features
2021-01-06 06:55:40 -05:00
2021-01-04 08:54:19 -05:00
[hedgedoc-community]: https://community.hedgedoc.org
2021-01-06 06:55:40 -05:00
2021-01-04 08:54:19 -05:00
[hedgedoc-community-calls]: https://community.hedgedoc.org/t/codimd-community-call/19
2021-01-06 06:55:40 -05:00
2021-01-04 08:54:19 -05:00
[social-mastodon]: https://social.hedgedoc.org/mastodon
2021-01-06 06:55:40 -05:00
2022-11-01 05:51:01 -04:00
[social-mastodon-image]: https://img.shields.io/mastodon/follow/109259563190314667?domain=https%3A%2F%2Ffosstodon.org& style=social
2021-01-06 06:55:40 -05:00
[reuse-workflow-badge]: https://github.com/hedgedoc/hedgedoc/workflows/REUSE%20Compliance%20Check/badge.svg
[nestjs-workflow-badge]: https://github.com/hedgedoc/hedgedoc/workflows/Nest.JS%20CI/badge.svg
[codecov-badge]: https://codecov.io/gh/hedgedoc/hedgedoc/branch/develop/graph/badge.svg?token=pdaRF4qjNQ
[codecov-url]: https://codecov.io/gh/hedgedoc/hedgedoc
