Skip to content
CodiMD - Realtime collaborative markdown notes on all platforms.
JavaScript HTML CSS Shell
Branch: master
Clone or download

Latest commit

SISheogorath Merge pull request #305 from ErikMichelson/fix/eslint
Fixed eslint errors in cleanup-script
Latest commit 9425caf Mar 21, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Fixed eslint errors (whitespaces) Mar 21, 2020
docs Adjust description of CMD_ALLOW_ANONYMOUS_EDITS Feb 11, 2020
lib Fix broken redirect on login Mar 21, 2020
locales Update fr.json (POEditor.com) Mar 21, 2020
public Release version 1.6.0 Feb 17, 2020
test Update RevealJS to version 3.9.2 Feb 1, 2020
.babelrc drop node 6 support May 13, 2019
.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 Add no-console as a warning May 12, 2019
.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 Remove Tests for EOL node version 8 Feb 16, 2020
AUTHORS Fix file permission, remove useless executable Dec 13, 2017
CHANGELOG.md integrating information from the old wiki Mar 31, 2019
CODE_OF_CONDUCT.md moving code of conduct into its own file for better discoverability Mar 31, 2019
CONTRIBUTING.md Move DCO into docs section Jun 10, 2019
LICENSE Fix LICENSE content Mar 31, 2019
README.md Replace dead browser icons and add missing Feb 16, 2020
SECURITY.md Add security note to repository Sep 10, 2019
app.js Move note actions to their own file. Oct 27, 2019
app.json Update app.json Feb 8, 2020
config.json.example also use gfm header generation in test and debug configuraitons Oct 30, 2019
package.json Release version 1.6.0 Feb 17, 2020
webpack.common.js Update RevealJS to version 3.9.2 Feb 1, 2020
webpack.dev.js Use webpack-merge. Oct 10, 2018
webpack.htmlexport.js Fix urlPath support, let CodiMD be served from a subpath correctly Dec 20, 2019
webpack.prod.js Fix urlPath support, let CodiMD be served from a subpath correctly Dec 20, 2019
yarn.lock Update yarn.lock Feb 16, 2020

README.md

CodiMD

#CodiMD on matrix.org 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 Chrome for Android >= 47
  • Safari Safari >= 9, iOS Safarai iOS Safari >= 8.4
  • Firefox Firefox >= 44
  • IE IE >= 9, Edge Edge >= 12
  • Opera Opera >= 34, Opera Mini Opera Mini not supported
  • Android Browser 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.