CodiMD - Realtime collaborative markdown notes on all platforms. https://hackmd.io/c/codimd-documentation
Go to file
Raccoon 3b1e270952
Merge pull request #1701 from YadominJinta/develop
Add arm64 docker image build.
2021-07-09 18:37:02 +08:00
.devcontainer chore: add dev container 2021-05-28 16:22:48 +08:00
.github/workflows Fix doctoc workflow 2021-06-10 12:51:47 +08:00
bin fix: heroku Proffile might show sensitive data in log 2020-03-02 23:51:40 +08:00
contribute Add sign you work section in contributing and DCO 2017-10-12 01:44:55 +08:00
deployments Add support for arm64 build 2021-07-05 19:03:03 +08:00
lib fix: S3 client config passing for image upload 2021-05-13 19:03:25 +08:00
locales fix typography of footer 2020-04-29 18:35:28 +08:00
public Merge pull request #1587 from tamo/more-i18n 2021-07-09 15:08:03 +08:00
test Fix standard 2020-07-01 11:42:28 +08:00
utils Fix standard 2020-07-01 11:42:28 +08:00
.babelrc Upgrade to Webpack 4 - first try 2018-09-06 17:26:09 +02:00
.buildpacks Added Scalingo compatible deployment 2019-11-29 11:52:01 +01:00
.dockerignore feat: add new dockerfile 2019-10-07 15:42:03 +08:00
.editorconfig Update editorconfig 2017-03-31 20:58:58 +08:00
.gitignore Update gitignore 2020-07-01 11:42:28 +08:00
.mailmap Add mailmap for contributors 2018-07-27 13:21:52 +02:00
.nvmrc chore: add .nvmrc to fix node version 2020-05-19 02:08:48 +08:00
.sequelizerc.example fix: Allow Sequelize CLI to use options set in config.json 2020-07-07 14:25:11 +02:00
AUTHORS Fix file permission, remove useless executable 2017-12-14 05:05:18 +08:00
CONTRIBUTING.md Update CONTRIBUTING.md 2021-02-18 16:28:00 +08:00
LICENSE Change license from MIT to AGPLv3 2017-10-12 01:45:57 +08:00
Procfile fix: heroku Proffile might show sensitive data in log 2020-03-02 23:51:40 +08:00
README.md Add matrix badge and links to README 2020-12-08 15:03:55 +03:00
app.js Add privacyPolicyURL (CMD_PRIVACY_POLICY_URL) 2020-09-01 20:54:08 +09:00
app.json Enforce PG ssl require mode 2021-02-28 11:20:39 +08:00
config.js fix: Allow Sequelize CLI to use options set in config.json 2020-07-07 14:25:11 +02:00
config.json.example also use gfm header generation in test and debug configuraitons 2019-10-29 10:00:34 +01:00
package-lock.json feat: upgrade mermaid to version 8.10.2 2021-06-16 19:10:30 +08:00
package.json Merge pull request #1688 from hackmdio/chore/dev-container 2021-06-16 21:27:29 +08:00
scalingo.json fix: change heroku and scalingo config schema for 2.0.0 2020-03-02 23:05:55 +08:00
webpack.common.js fix: webpack exclude path should support windows path 2021-04-27 18:24:47 +08:00
webpack.dev.js Use webpack-merge. 2018-10-10 22:09:46 +02:00
webpack.htmlexport.js Use webpack-merge. 2018-10-10 22:09:46 +02:00
webpack.prod.js Use webpack-merge. 2018-10-10 22:09:46 +02:00

README.md

CodiMD

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.

screenshot

Table of Contents

HackMD

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!

Documentation

You would find all documentation here: CodiMD Documentation

Deployment

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.

Configuration

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

Developer

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
  • IE / Edge IE >= 9, 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

License under AGPL.