HedgeDoc - Ideas grow better together
Find a file
Tilman Vatteroth a36d063da4
fix: correct docs
Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2023-04-15 12:16:16 +02:00
.github fix: install netlify nextjs plugin manually 2023-04-13 18:23:43 +02:00
.idea/copyright fixed copyright template for idea 2021-01-09 22:47:17 +01:00
.reuse misc: add turbo monorepo util 2023-02-07 21:38:40 +01:00
.yarn fix: suppress yjs double import warning 2023-04-13 10:38:20 +02:00
backend fix(deps): update dependency @azure/storage-blob to v12.14.0 2023-04-14 09:43:42 +02:00
commons feat: move title extraction into commons package 2023-04-14 20:38:41 +02:00
dev-reverse-proxy refactor: use separate env vars for frontend/backend port 2023-03-26 15:53:49 +02:00
docker fix(docker): remove docker image hashes from example docker-compose.yml 2023-03-28 09:13:29 +02:00
docs fix: usage of .env file in getting-started dev guide 2023-04-13 10:39:17 +02:00
frontend fix: correct docs 2023-04-15 12:16:16 +02:00
LICENSES feat(frontend): replace forkawesome with bootstrap icons 2023-02-24 14:31:17 +01:00
.dockerignore misc: add turbo monorepo util 2023-02-07 21:38:40 +01:00
.env.example refactor: move .env file to repo root 2023-03-26 15:53:49 +02:00
.env.example.license refactor: move .env file to repo root 2023-03-26 15:53:49 +02:00
.gitattributes fix(repo): fix gitattributes 2022-12-01 23:51:51 +01:00
.gitignore fix: add .env to gitignore 2023-02-12 22:10:31 +01:00
.mailmap Update mailmap and AUTHORS 2022-01-23 22:13:54 +01:00
.mailmap.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
.nvmrc fix: move nvmrc into root directory 2023-02-12 22:10:31 +01:00
.nvmrc.license fix: move nvmrc into root directory 2023-02-12 22:10:31 +01:00
.yarnrc.yml chore(deps): update yarn to v3.5.0 2023-03-17 09:01:42 +01:00
AUTHORS fix(repository): merge authors file 2022-11-20 21:49:56 +01:00
CODE_OF_CONDUCT.md Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
codecov.yml fix(ci): move codecov config to top-level 2022-11-20 23:02:13 +01:00
CONTRIBUTING.md docs: added sign-off guide to CONTRIBUTING.md 2021-12-18 15:47:12 +01:00
eslint-local-rules.js build: add eslint rule forbidding TypeORM Equal constructor 2023-03-25 16:29:14 +01:00
LICENSE Use 'HedgeDoc' in changelog and license 2022-02-14 11:50:02 +01:00
package.json chore(deps): update dependency @codemirror/autocomplete to v6.5.1 2023-04-14 09:42:41 +02:00
package.json.license feat(package): adjust packages to workspaces 2022-12-04 20:59:46 +01:00
README.md fix(docs): adjust frontend and reverse proxy docs 2022-11-20 21:49:56 +01:00
renovate.json fix: install netlify nextjs plugin manually 2023-04-13 18:23:43 +02:00
renovate.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
SECURITY.md docs(SECURITY): Shift vulnerability reporting directly to GitHub 2023-01-24 20:07:39 +01:00
turbo.json fix(turbo): ignore webpack cache 2023-03-31 12:38:47 +02:00
turbo.json.license misc: add turbo monorepo util 2023-02-07 21:38:40 +01:00
yarn.lock feat: move title extraction into commons package 2023-04-14 20:38:41 +02:00
yarn.lock.license feat(package): adjust packages to workspaces 2022-12-04 20:59:46 +01:00

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.