Mirror of HackMD with some custom changes
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Davide Depau 7b31ddecc3
Merge branch 'master' into DepauMD
3 months ago
bin cleanup of the heroku configuration 7 months ago
docs Slightly improve docker-linux-server.md 3 months ago
lib Merge branch 'master' into DepauMD 3 months ago
locales Merge branch 'master' into DepauMD 3 months ago
public Merge branch 'master' into DepauMD 3 months ago
test polyfilling scrypt for node 8.5+ 6 months ago
.babelrc drop node 6 support 6 months ago
.editorconfig specifying the locale jsons to be in the exact style of poeditor should cut down on unneccessary changes ('churn') 7 months ago
.eslintignore switching to eslint for code checking 1 year ago
.eslintrc.js Add no-console as a warning 6 months ago
.gitignore striving for consistency across various docs 7 months ago
.mailmap Add mailmap for contributors 1 year ago
.sequelizerc.example Create example config 3 years ago
.travis.yml travis config is now in stages 6 months ago
AUTHORS Update authors list and add contributors file 2 years ago
CHANGELOG.md integrating information from the old wiki 7 months ago
CODE_OF_CONDUCT.md moving code of conduct into its own file for better discoverability 7 months ago
CONTRIBUTING.md Move DCO into docs section 5 months ago
LICENSE Fix LICENSE content 7 months ago
README.md Fix some minor quirks in the LinuxServer.io docs 3 months ago
app.js Add vietnamese language 5 months ago
app.json cleanup of the heroku configuration 7 months ago
config.json.example Added a configuration option for passport-saml: 7 months ago
package.json Merge branch 'master' into DepauMD 3 months ago
webpack.common.js Merge branch 'master' into DepauMD 5 months ago
webpack.dev.js Use webpack-merge. 1 year ago
webpack.htmlexport.js Use webpack-merge. 1 year ago
webpack.prod.js Use webpack-merge. 1 year ago
yarn.lock Update yarn.lock 3 months ago

README.md

CodiMD

build status version POEditor Mastodon

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

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.