Mirror of HackMD with some custom changes
Find a file
Claudius edf301cfa3 splitting README.md into files in /docs for better readability
Signed-off-by: Claudius <opensource@amenthes.de>
2019-04-01 01:03:36 +02:00
bin cleanup of the heroku configuration 2019-03-31 01:29:34 +01:00
contribute Add sign you work section in contributing and DCO 2017-10-12 01:44:55 +08:00
docs splitting README.md into files in /docs for better readability 2019-04-01 01:03:36 +02:00
lib Merge pull request #7 from SISheogorath/feature/libravatar 2019-03-31 03:30:51 +02:00
locales Update ja.json (POEditor.com) 2019-03-20 15:40:28 +01:00
public Merge pull request #9 from SISheogorath/feature/moveUpload 2019-03-31 15:14:31 +02:00
test Use libravatar as drop-in replacement for gravatar 2019-03-17 23:51:54 +01:00
.babelrc Upgrade to Webpack 4 - first try 2018-09-06 17:26:09 +02:00
.editorconfig Update editorconfig 2017-03-31 20:58:58 +08:00
.eslintignore switching to eslint for code checking 2018-11-14 23:15:36 +01:00
.eslintrc.js switching to eslint for code checking 2018-11-14 23:15:36 +01:00
.gitignore Add package-lock.json to .gitignore 2018-01-18 11:21:07 +01: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 After removing ws, node version 10 should work 2018-11-19 18:42:28 +01:00
app.js Add serbian language 2019-03-04 13:21:01 +01:00
app.json cleanup of the heroku configuration 2019-03-31 01:29:34 +01:00
AUTHORS Fix file permission, remove useless executable 2017-12-14 05:05:18 +08:00
config.json.example Fix wrong value type in example config 2019-03-04 16:59:44 +01:00
CONTRIBUTING.md Rebrand HackMD to CodiMD 2018-06-24 13:24:12 +02:00
LICENSE Fix LICENSE content 2019-03-31 03:27:12 +02:00
package.json cleanup of the heroku configuration 2019-03-31 01:29:34 +01:00
README.md splitting README.md into files in /docs for better readability 2019-04-01 01:03:36 +02:00
webpack.common.js Remove the xss library from webpack 2018-11-10 20:27:07 +01: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 Update yarn.lock 2019-03-23 13:25:33 +01:00

CodiMD

#CodiMD on matrix.org build status version POEditor

CodiMD lets you create real-time collaborative markdown notes on all platforms. 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 want to 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 your installation it's recommended to join our Matrix channel or subscribe to the release feed.

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

License

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