HedgeDoc - Ideas grow better together
Find a file
2020-11-11 21:02:42 +01:00
.github/workflows Migrate to GitHub Actions 2020-11-11 20:44:18 +01:00
bin Fixed eslint errors (whitespaces) 2020-03-21 23:27:00 +01:00
docs Update configuration.md 2020-10-11 13:43:40 +02:00
lib Generic OAuth2: Set state: true 2020-10-22 22:50:34 +02:00
locales Add Malayalam translation 2020-09-09 12:51:34 +02:00
public Merge pull request #547 from codimd/upgrade-deps 2020-11-11 19:20:43 +01:00
test Add test for dropbox csp rule 2020-08-23 01:41:55 +02:00
.babelrc drop node 6 support 2019-05-13 19:37:21 +02:00
.editorconfig specifying the locale jsons to be in the exact style of poeditor should cut down on unneccessary changes ('churn') 2019-04-04 12:31:38 +02:00
.eslintignore switching to eslint for code checking 2018-11-14 23:15:36 +01:00
.eslintrc.js Add no-console as a warning 2019-05-12 20:15:46 +02:00
.gitignore striving for consistency across various docs 2019-04-01 01:03:36 +02:00
.mailmap Add mailmap for contributors 2018-07-27 13:21:52 +02:00
.remarkrc fix: override markdown linting preset 2020-07-10 18:57:31 +02:00
.sequelizerc.example Create example config 2016-10-05 10:58:05 +08:00
app.js Merge pull request #497 from SISheogorath/translation/malayalam 2020-09-26 15:27:06 +02:00
app.json Add config option for cookie SameSite policy 2020-08-27 02:04:49 +02:00
AUTHORS Fix file permission, remove useless executable 2017-12-14 05:05:18 +08:00
CHANGELOG.md style: linting markdown files 2020-07-10 18:57:59 +02:00
CODE-OF-CONDUCT.md style: linting markdown files 2020-07-10 18:57:59 +02:00
config.json.example Use lax cookiePolicy in example config 2020-11-11 19:30:59 +01:00
CONTRIBUTING.md style: linting markdown files 2020-07-10 18:57:59 +02:00
LICENSE Fix LICENSE content 2019-03-31 03:27:12 +02:00
package.json Use our fork of CodeMirror 2020-11-11 20:20:24 +01:00
README.md Change all element.io links to matrix.to links 2020-09-28 13:05:22 +02:00
SECURITY.md Change all element.io links to matrix.to links 2020-09-28 13:05:22 +02:00
webpack.common.js Revert "Adjust webpack config to new code mirror version" 2020-11-11 20:16:47 +01:00
webpack.dev.js Use new source map naming for the Webpack dev config 2020-11-10 22:56:00 +01:00
webpack.htmlexport.js Fix urlPath support, let CodiMD be served from a subpath correctly 2019-12-20 12:03:16 +01:00
webpack.prod.js Fix urlPath support, let CodiMD be served from a subpath correctly 2019-12-20 12:03:16 +01:00
yarn.lock Use our fork of CodeMirror 2020-11-11 20:20:24 +01:00

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.

Note: CodiMD is in the process of changing its name to HedgeDoc.

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:

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

Backup/restore your instance

To backup codimd, you should:

  • backup your database
  • backup your custom config file if you have one
  • backup the upload folder (see the uploadsPath config directive)

Restoring an existing instance of codimd is then just a matter of restoring these elements.

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.