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.
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 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.
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.
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 |
CodiMD is a service that runs on Node.js, while users use the service through browsers. We support your users using the following browsers:
To stay up to date with your installation it's recommended to subscribe the release feed.
License under AGPL.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。