CodiMD - Realtime collaborative markdown notes on all platforms. https://hackmd.io/c/codimd-documentation
Go to file
BoHong Li f5c73d3439
refactor: fix lint on test/realtime/updateNote.test.js
Signed-off-by: BoHong Li <raccoon@hackmd.io>
2019-08-04 23:56:35 +08:00
bin refactor: fix lint warning on bin/manage_users 2019-04-12 18:24:55 +08:00
contribute Add sign you work section in contributing and DCO 2017-10-12 01:44:55 +08:00
deployments fix: change note permission cause error 2019-07-30 18:09:17 +08:00
docs Fix several typos in auth/saml.md 2019-02-15 04:14:17 +08:00
lib refactor: fix lint on lib/response.js 2019-08-04 23:56:32 +08:00
locales translation: Fix some translations in zh-TW 2019-05-01 18:52:40 +08:00
public refactor: fix lint on public/js/lib/editor/index.js 2019-08-04 23:56:33 +08:00
test refactor: fix lint on test/realtime/updateNote.test.js 2019-08-04 23:56:35 +08:00
utils refactor: fix lint warning on utils/string.js 2019-04-12 18:00:23 +08:00
.babelrc Upgrade to Webpack 4 - first try 2018-09-06 17:26:09 +02:00
.dockerignore fix: change note permission cause error 2019-07-30 18:09:17 +08:00
.editorconfig Update editorconfig 2017-03-31 20:58:58 +08:00
.gitignore feat: add nyc for unit test code coverage 2019-05-27 17:53:02 +08:00
.mailmap Add mailmap for contributors 2018-07-27 13:21:52 +02:00
.sequelizerc.example Create example config 2016-10-05 10:58:05 +08:00
.travis.yml ci: update 2019-05-27 18:35:35 +08:00
AUTHORS Fix file permission, remove useless executable 2017-12-14 05:05:18 +08:00
CONTRIBUTING.md Rebrand HackMD to CodiMD 2018-06-24 13:24:12 +02:00
LICENSE Change license from MIT to AGPLv3 2017-10-12 01:45:57 +08:00
README.md Merge branch 'develop' into refactor-realtime 2019-07-30 18:20:09 +08:00
app.js refactor: fix lint on app.js 2019-08-04 23:56:25 +08:00
app.json Update links of Gitter, POEditor and Travis CI 2019-07-28 19:00:17 +08:00
config.json.example fix: add default value for plantuml server and use https 2019-08-03 21:23:28 +08:00
package.json chore: upgrade standard to 13 2019-08-04 23:56:25 +08:00
webpack.common.js chore: upgrade spin.js to 4.0.0 2019-08-04 23:56:24 +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
yarn.lock chore: upgrade standard to 13 2019-08-04 23:56:25 +08:00

README.md

CodiMD

CodiMD on Gitter build status version Gitter 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.

Table of Contents

CodiMD - The Open Source 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:

With the same promise of you owning your content, CodiMD is the free software version of HackMD, developed and opened source by the HackMD team with reduced features, so you can use CodiMD for your community and own 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
    • 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.