CodiMD

CodiMD is a platform for sharing and writing notes in Markdown. CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with reduced features (without book mode). CodiMD has as features a markdown editor, export as PDF, import from Gist, as well as slides and notes support.

CodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for commercial use cases. HackMD team is committed to keep CodiMD open source. All contributions are welcome!

You would find all documentation here: CodiMD Documentation

Deployment

If you want to spin up an instance and start using immediately, see Docker deployment. If you want to contribute to the project, start with manual deployment.

Configuration

CodiMD is highly customizable, learn about all configuration options of networking, security, performance, resources, privilege, privacy, image storage, and authentication in CodiMD Configuration.

Upgrading and Migration

Upgrade CodiMD from previous version? See this guide
Migrating from Etherpad? Follow this guide

Developer

Join our contributor community! Start from deploying CodiMD manually, connecting to your own database, learn about the project structure, to build your changes with the help of webpack.