Repository files navigation

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

• HackMD
• CodiMD - The Open Source HackMD
• Documentation
  • Deployment
  • Configuration
  • Upgrading and Migration
  • Developer
• Contribution and Discussion
• Browser Support
• License

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:

• You should be able to easilydownload all your online content at once.
• Your content formatting should be portable as well. (That's why we choosemarkdown.)
• You should be able to control your content's presentation with HTML,slide mode, orbook mode.

CodiMD is the free software version ofHackMD, developed and open sourced by the HackMD team with reduced features (without book mode), you can use CodiMD for your community and own all your data.(See theorigin 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, seeDocker deployment.If you want to contribute to the project, start withmanual deployment.

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

Upgrade CodiMD from previous version? Seethis guide
Migrating from Etherpad? Followthis guide

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

All contributions are welcome! Even asking a question helps.

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 >= 47, Chrome for Android >= 47
• Safari >= 9, iOS Safari >= 8.4
• Firefox >= 44
• Edge >= 12
• Opera >= 34, Opera Mini not supported
• Android Browser >= 4.4

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

License under AGPL.