CodiMD lets you create real-time collaborative markdown notes. You can test-drive it by visiting our CodiMD demo server.
Note: CodiMD is in the process of changing its name to HedgeDoc.
It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at HackMD and now forked into its own organisation. A longer writeup can be read in the history doc.
We welcome contributions! There's a lot to do: If you would like to report bugs, the issue tracker is the right place. If you can help translating, find us on POEditor. To get started developing, take a look at the docs/dev directory. In any case: come talk to us, we'll be delighted to help you with the first steps.
To stay up to date with our work or get support it's recommended to join our Matrix channel, stop by our community forums or subscribe to the release feed. We also engage in regular community calls (RSS) which you are very welcome to join.
You can run CodiMD in a number of ways, and we created setup instructions for all of these:
Theres two main ways to configure your CodiMD instance: config file or environment variables. You can choose what works best for you.
CodiMD can integrate with
More info about that can be found in the configuration docs above.
To use CodiMD, your browser should match or exceed these versions:
To backup codimd, you should:
Restoring an existing instance of codimd is then just a matter of restoring these elements.
Our community has created related tools, we'd like to highlight codimd-cli which lets you use CodiMD from the comfort of your command line.
Licensed under AGPLv3. For our list of contributors, see AUTHORS.