Skip to content
CodiMD - Realtime collaborative markdown notes on all platforms.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin cleanup of the heroku configuration Mar 31, 2019
contribute
docs fixing manual upgrade instructions and completing requirements Apr 15, 2019
lib Add lutim support Apr 9, 2019
locales Update de.json (POEditor.com) Apr 19, 2019
public Replace js-url with wurl Apr 16, 2019
test Use libravatar as drop-in replacement for gravatar Mar 17, 2019
.babelrc Upgrade to Webpack 4 - first try Sep 6, 2018
.editorconfig specifying the locale jsons to be in the exact style of poeditor shou… Apr 4, 2019
.eslintignore switching to eslint for code checking Nov 14, 2018
.eslintrc.js switching to eslint for code checking Nov 14, 2018
.gitignore striving for consistency across various docs Mar 31, 2019
.mailmap Add mailmap for contributors Jul 27, 2018
.sequelizerc.example Create example config Oct 5, 2016
.travis.yml Update yarn to version 1.15.2 Apr 10, 2019
AUTHORS
CHANGELOG.md integrating information from the old wiki Mar 31, 2019
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE Fix LICENSE content Mar 31, 2019
README.md
app.js fix unix socket not removed on shutdown (#50) Apr 16, 2019
app.json cleanup of the heroku configuration Mar 31, 2019
config.json.example Added a configuration option for passport-saml: Apr 6, 2019
package.json
webpack.common.js Replace js-url with wurl Apr 16, 2019
webpack.dev.js Use webpack-merge. Oct 10, 2018
webpack.htmlexport.js Use webpack-merge. Oct 10, 2018
webpack.prod.js Use webpack-merge. Oct 10, 2018
yarn.lock Update yarn.lock Apr 16, 2019

README.md

CodiMD

#CodiMD on matrix.org build status version POEditor

CodiMD lets you create real-time collaborative markdown notes. You can test-drive it by visiting our CodiMD demo server.

It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at HackMD and now forked into its own organisation. A longer writeup can be read in the history doc.

CodiMD 1.3.2 with its feature demonstration page open

Community and Contributions

We welcome contributions! There's a lot to do: If you would like to report bugs, the issue tracker is the right place. If you can help translating, find us on POEditor. To get started developing, take a look at the docs/dev directory. In any case: come talk to us, we'll be delighted to help you with the first steps.

To stay up to date with our work or get support it's recommended to join our Matrix channel, stop by our community forums or subscribe to the release feed. We also engage in regular community calls (RSS) which you are very welcome to join.

Installation / Upgrading

You can run CodiMD in a number of ways, and we created setup instructions for all of these:

If you do not wish to run your own setup, you can find a commercial offering at https://hackmd.io. This is not the same codebase as this one, but it is a very similar project.

Configuration

Theres two main ways to configure your CodiMD instance: Config file or environment variables. You can choose what works best for you.

CodiMD can integrate with

  • facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and oauth2 for login
  • imgur, s3, minio, azure for image/attachment storage (files can also be local!)
  • dropbox for export and import

More info about that can be found in the configuration docs above.

Browser support

To use CodiMD, your browser should match or exceed these versions:

  • 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

Related Tools

Our community has created related tools, we'd like to highlight codimd-cli which lets you use CodiMD from the comfort of your command line.

License

Licensed under AGPLv3. For our list of contributors, see AUTHORS.

You can’t perform that action at this time.