HedgeDoc lets you create real-time collaborative markdown notes.
- ℹ️ Read all about HedgeDoc and the history of the project on our website
- 🧪 Try out HedgeDoc with the demo instance. Check out the features page!
- 💽 Install HedgeDoc yourself using the install guide
- ❓ Questions? Join our Matrix chat or the community forums
- 💬 Stay up to date by subscribing to the release feed
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.
This fork includes the nodeBook extension, which renders Controlled Natural Language (CNL) knowledge graphs inline within markdown documents. Users write structured text inside ```nodeBook code fences and see interactive graph visualizations powered by Cytoscape.js — with support for typed nodes, weighted relations, polymorphic morphs, schema validation, transitive inference, Prolog queries, and a 9-category scoring rubric. All parsing and rendering is client-side with no backend changes required. See the nodeBook README for full documentation, and try it live with the guided tutorial at nodebook.co.in.
The nodeBook engine and renderer are published as standalone npm packages, so any editor or site can embed CNL knowledge graphs:
| Package | Purpose |
|---|---|
@nodebook/core |
CNL parser, graph engine, inference (transitive closure + Prolog), schemas |
@nodebook/dom |
Framework-agnostic interactive renderer (Cytoscape.js) + <nodebook-graph> web component |
@nodebook/react |
Full-featured React components (used by this frontend) |
@nodebook/markdown-it |
markdown-it plugin turning ```nodeBook fences into hydratable placeholders |
Editor plugins built on these packages:
- Logseq — install nodeBook from the Logseq Marketplace (source, monorepo dev copy in
apps/logseq-nodebook) - Obsidian — gnowgi/obsidian-nodebook (monorepo dev copy in
apps/obsidian-nodebook) - Standalone app —
apps/nodebook-app, a Vite + Tauri + PWA editor
Information for setting up a local development environment can be found in the developer documentation
Curious about the new look and feel of HedgeDoc 2? We provide a demo of the alpha on hedgedoc.dev.
If you want to try it out on your own devices, visit the HedgeDoc 2 docs. But be aware that these may change over time.
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.
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.