github/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-21 09:16:30 -05:00
Code Issues Projects Releases Packages Wiki Activity
HedgeDoc - Ideas grow better together
4191 commits 39 branches 47 tags 111 MiB
TypeScript 96.4%
SCSS 3.2%
JavaScript 0.2%
Dockerfile 0.1%
Find a file
Tilman Vatteroth 7320fe2ac1 feat(packages): add commons package 
This is an import of 166ca8da12
with some changes to make it fit into the mono repo.
- TypedEventEmitter has been replaced with EventEmitter2 because EventEmitter2 is faster and TypedEventEmitter had some troubles with the new way of compiling.
- tsc-esm has been replaced with microbundle. The problems that lib0 doesn't export its types correctly has been solved using yarn patch.

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
2022-12-11 23:09:10 +01:00
.github feat(packages): add commons package 2022-12-11 23:09:10 +01:00
.idea/copyright fixed copyright template for idea 2021-01-09 22:47:17 +01:00
.reuse feat(package): adjust packages to workspaces 2022-12-04 20:59:46 +01:00
.yarn feat(packages): add commons package 2022-12-11 23:09:10 +01:00
backend chore(deps): update dependency prettier to v2.8.1 2022-12-11 22:26:44 +01:00
commons feat(packages): add commons package 2022-12-11 23:09:10 +01:00
dev-reverse-proxy fix(docs): adjust frontend and reverse proxy docs 2022-11-20 21:49:56 +01:00
docs chore(deps): update dependency pymdown-extensions to v9.9 2022-12-04 21:37:21 +01:00
frontend chore(deps): update dependency prettier to v2.8.1 2022-12-11 22:26:44 +01:00
LICENSES fix(repository): merge licenses 2022-11-20 21:49:56 +01:00
.dockerignore fix(repository): Move backend code into subdirectory 2022-10-30 22:46:42 +01:00
.gitattributes fix(repo): fix gitattributes 2022-12-01 23:51:51 +01:00
.gitignore fix(gitignore): correct yarn directory rule to accept the subdirectory exception rules 2022-12-11 23:09:10 +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
.yarnrc.yml feat(package): adjust packages to workspaces 2022-12-04 20:59:46 +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 feat(package): adjust packages to workspaces 2022-12-04 20:59:46 +01:00
LICENSE Use 'HedgeDoc' in changelog and license 2022-02-14 11:50:02 +01:00
package.json feat(packages): add commons package 2022-12-11 23:09:10 +01: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(repository): merge renovate config 2022-11-20 21:49:56 +01:00
renovate.json.license Change year in copyright to 2021 2021-01-06 21:36:07 +01:00
SECURITY.md Update security.md to match state in master branch 2021-09-21 15:19:46 +02:00
yarn.lock feat(packages): add commons package 2022-12-11 23:09:10 +01:00
yarn.lock.license feat(package): adjust packages to workspaces 2022-12-04 20:59:46 +01:00

README.md

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.