{"id":13425929,"url":"https://github.com/hackmdio/codimd","last_synced_at":"2025-05-16T01:00:26.940Z","repository":{"id":31453415,"uuid":"35017238","full_name":"hackmdio/codimd","owner":"hackmdio","description":"CodiMD - Realtime collaborative markdown notes on all platforms.","archived":false,"fork":false,"pushed_at":"2025-04-18T05:28:06.000Z","size":27570,"stargazers_count":9633,"open_issues_count":346,"forks_count":1100,"subscribers_count":162,"default_branch":"develop","last_synced_at":"2025-05-08T22:16:35.605Z","etag":null,"topics":["codimd","collaboration","hackmd","markdown","notes","realtime"],"latest_commit_sha":null,"homepage":"https://hackmd.io/c/codimd-documentation","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hackmdio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-05-04T06:06:45.000Z","updated_at":"2025-05-08T19:10:22.000Z","dependencies_parsed_at":"2024-04-30T11:46:32.190Z","dependency_job_id":"64f635df-77b5-4dd3-b1ac-d181701f912e","html_url":"https://github.com/hackmdio/codimd","commit_stats":{"total_commits":2303,"total_committers":189,"mean_commits":"12.185185185185185","dds":0.60790273556231,"last_synced_commit":"b6eba056e5b3efe9ee0e5c1cde4236dfd4901381"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fcodimd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fcodimd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fcodimd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hackmdio%2Fcodimd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hackmdio","download_url":"https://codeload.github.com/hackmdio/codimd/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253154983,"owners_count":21862624,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["codimd","collaboration","hackmd","markdown","notes","realtime"],"created_at":"2024-07-31T00:01:22.255Z","updated_at":"2025-05-08T22:16:39.204Z","avatar_url":"https://github.com/hackmdio.png","language":"JavaScript","readme":"CodiMD\n===\n\n[![build status][travis-image]][travis-url]\n[![version][github-version-badge]][github-release-page]\n[![Gitter][gitter-image]][gitter-url]\n[![Matrix][matrix-image]][matrix-url]\n[![POEditor][poeditor-image]][poeditor-url]\n\nCodiMD lets you collaborate in real-time with markdown.\nBuilt on [HackMD](https://hackmd.io) source code, CodiMD lets you host and control your team's content with speed and ease.\n\n![screenshot](https://raw.githubusercontent.com/hackmdio/codimd/develop/public/screenshot.png)\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n# Table of Contents\n\n- [HackMD](#hackmd)\n- [CodiMD - The Open Source HackMD](#codimd---the-open-source-hackmd)\n- [Documentation](#documentation)\n  - [Deployment](#deployment)\n  - [Configuration](#configuration)\n  - [Upgrading and Migration](#upgrading-and-migration)\n  - [Developer](#developer)\n- [Contribution and Discussion](#contribution-and-discussion)\n- [Browser Support](#browser-support)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## HackMD\n\n[HackMD](https://hackmd.io) helps developers write better documents and build active communities with open collaboration.\nHackMD is built with one promise - **You own and control all your content**:\n- You should be able to easily [download all your online content at once](https://hackmd.io/c/news/%2Fs%2Fr1cx3a3SE).\n- Your content formatting should be portable as well. (That's why we choose [markdown](https://hackmd.io/features#Typography).)\n- You should be able to control your content's presentation with HTML, [slide mode](https://hackmd.io/p/slide-example), or [book mode](https://hackmd.io/c/book-example/).\n\n## CodiMD - The Open Source HackMD\n\nCodiMD is the free software version of [HackMD](https://hackmd.io), 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 the [origin of the name CodiMD](https://github.com/hackmdio/hackmd/issues/720).)* \n\nCodiMD is perfect for open communities, while HackMD emphasizes on permission and access controls for commercial use cases. \n\nHackMD team is committed to keep CodiMD open source. All contributions are welcome!\n\n## Documentation\nYou would find all documentation here: [CodiMD Documentation](https://hackmd.io/c/codimd-documentation)\n\n### Deployment\nIf you want to spin up an instance and start using immediately, see [Docker deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-docker-deployment).\nIf you want to contribute to the project, start with [manual deployment](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-manual-deployment).\n\n### Configuration\nCodiMD is highly customizable, learn about all configuration options of networking, security, performance, resources, privilege, privacy, image storage, and authentication in [CodiMD Configuration](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-configuration).\n\n### Upgrading and Migration\nUpgrade CodiMD from previous version? See [this guide](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-upgrade)\u003cbr\u003e\nMigrating from Etherpad? Follow [this guide](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-migration-etherpad)\n\n### Developer\nJoin our contributor community! Start from deploying [CodiMD manually](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-manual-deployment), [connecting to your own database](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-db-connection), [learn about the project structure](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-project-structure), to [build your changes](https://hackmd.io/c/codimd-documentation/%2Fs%2Fcodimd-webpack) with the help of webpack.\n\n## Contribution and Discussion\nAll contributions are welcome! Even asking a question helps.\n\n| Project | Contribution Types | Contribution Venue |\n| ------- | ------------------ | ------------------ |\n|**CodiMD**|:couple: Community chat|[Gitter][gitter-url]|\n||:bug: Issues, bugs, and feature requests|[Issue tracker](https://github.com/hackmdio/codimd/issues)|\n||:books: Improve documentation|[Documentations](https://hackmd.io/c/codimd-documentation)|\n||:pencil: Translation|[POEditor][poeditor-url]|\n||:coffee: Donation|[Buy us coffee](https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=KDGS4PREHX6QQ\u0026lc=US\u0026item_name=HackMD\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted)|\n|**HackMD**|:question: Issues related to [HackMD](https://hackmd.io/)|[Issue tracker](https://github.com/hackmdio/hackmd-io-issues/issues)|\n||:pencil2: Translation|[hackmd-locales](https://github.com/hackmdio/hackmd-locales/tree/master/locales)|\n\n## Browser Support\n\nCodiMD is a service that runs on Node.js, while users use the service through browsers. We support your users using the following browsers: \n- \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/chrome/chrome_48x48.png\" alt=\"Chrome\" width=\"24px\" height=\"24px\" /\u003e Chrome \u003e= 47, Chrome for Android \u003e= 47\n- \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/safari/safari_48x48.png\" alt=\"Safari\" width=\"24px\" height=\"24px\" /\u003e Safari \u003e= 9, iOS Safari \u003e= 8.4\n- \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/firefox/firefox_48x48.png\" alt=\"Firefox\" width=\"24px\" height=\"24px\" /\u003e Firefox \u003e= 44\n- \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/edge/edge_48x48.png\" alt=\"Edge\" width=\"24px\" height=\"24px\" /\u003e Edge \u003e= 12\n- \u003cimg src=\"https://raw.githubusercontent.com/alrra/browser-logos/master/src/opera/opera_48x48.png\" alt=\"Opera\" width=\"24px\" height=\"24px\" /\u003e Opera \u003e= 34, Opera Mini not supported\n- Android Browser \u003e= 4.4\n\nTo stay up to date with your installation it's recommended to subscribe the [release feed][github-release-feed].\n\n## License\n\n**License under AGPL.**\n\n[gitter-image]: https://img.shields.io/badge/gitter-hackmdio/codimd-blue.svg\n[gitter-url]: https://gitter.im/hackmdio/hackmd\n[travis-image]: https://travis-ci.com/hackmdio/codimd.svg?branch=master\n[travis-url]: https://travis-ci.com/hackmdio/codimd\n[github-version-badge]: https://img.shields.io/github/release/hackmdio/codimd.svg\n[github-release-page]: https://github.com/hackmdio/codimd/releases\n[github-release-feed]: https://github.com/hackmdio/codimd/releases.atom\n[poeditor-image]: https://img.shields.io/badge/POEditor-translate-blue.svg\n[poeditor-url]: https://poeditor.com/join/project/q0nuPWyztp\n[matrix-image]: https://img.shields.io/matrix/hackmdio_hackmd:gitter.im?color=blue\u0026logo=matrix\n[matrix-url]: https://matrix.to/#/#hackmdio_hackmd:gitter.im\n","funding_links":["https://www.paypal.com/cgi-bin/webscr?cmd=_donations\u0026business=KDGS4PREHX6QQ\u0026lc=US\u0026item_name=HackMD\u0026currency_code=USD\u0026bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted"],"categories":["JavaScript","Apps","markdown","[↑](#-contents) Free or Open Source","[↑](#-contents) Free","Development","Herramientas","Open Source","Programming technologies","Table of Contents","Uncategorized"],"sub_categories":["Writing","Compartir y colaborar","Web UI","Tools","Markdown Editor","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fcodimd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhackmdio%2Fcodimd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhackmdio%2Fcodimd/lists"}