Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time
March 23, 2023 21:05
July 1, 2020 11:42
July 1, 2020 11:42
September 6, 2018 17:26
October 7, 2019 15:42
March 31, 2017 20:58
July 1, 2020 11:42
February 18, 2021 16:28
February 28, 2021 11:20
October 10, 2018 22:09
October 10, 2018 22:09
October 10, 2018 22:09


build status version Gitter Matrix POEditor

CodiMD lets you collaborate in real-time with markdown. Built on HackMD source code, CodiMD lets you host and control your team's content with speed and ease.


Table of Contents


HackMD helps developers write better documents and build active communities with open collaboration. HackMD is built with one promise - You own and control all your content:

CodiMD - The Open Source HackMD

CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with reduced features (without book mode), you can use CodiMD for your community and own all your data. (See the origin of the name CodiMD.)

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


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.


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


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.

Contribution and Discussion

All contributions are welcome! Even asking a question helps.

Project Contribution Types Contribution Venue
CodiMD 👫 Community chat Gitter
🐛 Issues, bugs, and feature requests Issue tracker
📚 Improve documentation Documentations
📝 Translation POEditor
Donation Buy us coffee
HackMD Issues related to HackMD Issue tracker
✏️ Translation hackmd-locales

Browser Support

CodiMD is a service that runs on Node.js, while users use the service through browsers. We support your users using the following browsers:

  • Chrome Chrome >= 47, Chrome for Android >= 47
  • Safari Safari >= 9, iOS Safari >= 8.4
  • Firefox Firefox >= 44
  • Edge Edge >= 12
  • Opera Opera >= 34, Opera Mini not supported
  • Android Browser >= 4.4

To stay up to date with your installation it's recommended to subscribe the release feed.


License under AGPL.