Chrome >= 47, Chrome for Android >= 47
Safari >= 9, iOS Safari >= 8.4
Firefox >= 44
Edge >= 12
Opera >= 34, Opera Mini not supportedWhat is this?
A self-hosted web app for real-time collaborative markdown notes — the free, open-source version of HackMD. Your team or community writes together in the browser while you keep full control of the data.
A self-hosted web app for real-time collaborative markdown notes — the free, open-source version of HackMD. Your team or community writes together in the browser while you keep full control of the data.How is it different from HackMD?It is open sourced by the HackMD team and built on HackMD's code, minus some features — book mode is HackMD-only. CodiMD suits open communities, while HackMD adds permission and access controls for commercial use.
It is open sourced by the HackMD team and built on HackMD's code, minus some features — book mode is HackMD-only. CodiMD suits open communities, while HackMD adds permission and access controls for commercial use.How do I get my own instance running?Fastest way is Docker deployment — spin up an instance and start using it right away. For development, deploy manually on Node.js and run 'sequelize db:migrate && node app.js'.
Fastest way is Docker deployment — spin up an instance and start using it right away. For development, deploy manually on Node.js and run 'sequelize db:migrate && node app.js'.What do I need on the server to run it?Node.js between 14 and 16 (engines pin >=14.0.0 <17.0.0) and a database — the start script runs Sequelize migrations first. Your users need nothing but a browser.
Node.js between 14 and 16 (engines pin >=14.0.0 <17.0.0) and a database — the start script runs Sequelize migrations first. Your users need nothing but a browser.Which browsers will my users need?Old versions are enough: Chrome 47+, Firefox 44+, Edge 12+, Opera 34+, Safari 9+ (iOS Safari 8.4+) and Android Browser 4.4+. Opera Mini is not supported.
Old versions are enough: Chrome 47+, Firefox 44+, Edge 12+, Opera 34+, Safari 9+ (iOS Safari 8.4+) and Android Browser 4.4+. Opera Mini is not supported.Who owns the notes stored on my instance?You do — you can download all your online content at once, and markdown keeps formatting portable. Presentation stays under your control too, via HTML and slide mode.
You do — you can download all your online content at once, and markdown keeps formatting portable. Presentation stays under your control too, via HTML and slide mode.What can I tweak on my own instance?Configuration is highly customizable: networking, security, performance, resources, privilege, privacy, image storage and authentication each have dedicated options in the CodiMD configuration docs.
Configuration is highly customizable: networking, security, performance, resources, privilege, privacy, image storage and authentication each have dedicated options in the CodiMD configuration docs.Where can uploaded images be stored?The codebase ships integrations for Amazon S3, Azure Storage and Imgur, so you can choose where image uploads land based on your infrastructure.
The codebase ships integrations for Amazon S3, Azure Storage and Imgur, so you can choose where image uploads land based on your infrastructure.Can I move my notes over from Etherpad?Yes — there is a dedicated migration guide for Etherpad, plus an upgrade guide for bringing older CodiMD instances to new versions.
Yes — there is a dedicated migration guide for Etherpad, plus an upgrade guide for bringing older CodiMD instances to new versions.Is there a way to present notes, not just write them?Yes — besides rendering as HTML, notes can be shown in slide mode. Book mode exists only in the commercial HackMD, not in CodiMD.
Yes — besides rendering as HTML, notes can be shown in slide mode. Book mode exists only in the commercial HackMD, not in CodiMD.What are similar projects?outline, AFFiNE, overleaf, open-knowledge, docs, logseq, PandaWiki, Trilium
outline, AFFiNE, overleaf, open-knowledge, docs, logseq, PandaWiki, TriliumWhich topics is it in?markdown-editor, notes, realtime, note-taking, collaboration, editor, agpl, documentation, web-app, markdown, server, nodejs
markdown-editor, notes, realtime, note-taking, collaboration, editor, agpl, documentation, web-app, markdown, server, nodejs