mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-26 21:51:42 +00:00

HedgeDoc - Ideas grow better together

codimd collaboration hacktoberfest hedgedoc markdown notes real-time

Find a file

Simon Fish 335065cba9 Provide documentation for configuration with Keycloak Signed-off-by: Simon Fish <si@mon.fish>		2019-05-06 17:15:07 +01:00
bin	cleanup of the heroku configuration	2019-03-31 01:29:34 +01:00
contribute
docs	Provide documentation for configuration with Keycloak	2019-05-06 17:15:07 +01:00
lib	Add lutim support	2019-04-10 01:37:12 +02:00
locales	Update sv.json (POEditor.com)	2019-04-25 10:17:24 +02:00
public	Update jQuery to version 3.4.1	2019-05-06 10:42:41 +02:00
test
.babelrc
.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
.eslintrc.js
.gitignore	striving for consistency across various docs	2019-04-01 01:03:36 +02:00
.mailmap
.sequelizerc.example
.travis.yml	Update yarn to version 1.15.2	2019-04-10 13:40:54 +02:00
app.js	fix unix socket not removed on shutdown (#50 )	2019-04-16 18:19:11 +02:00
app.json	cleanup of the heroku configuration	2019-03-31 01:29:34 +01:00
AUTHORS
CHANGELOG.md	integrating information from the old wiki	2019-04-01 01:03:36 +02:00
CODE_OF_CONDUCT.md	moving code of conduct into its own file for better discoverability	2019-04-01 01:26:42 +02:00
config.json.example	Added a configuration option for passport-saml:	2019-04-06 17:54:58 +02:00
CONTRIBUTING.md	moving code of conduct into its own file for better discoverability	2019-04-01 01:26:42 +02:00
LICENSE	Fix LICENSE content	2019-03-31 03:27:12 +02:00
package.json	Update jQuery to version 3.4.1	2019-05-06 10:42:41 +02:00
README.md	tiny correction to url. also adding RSS feed.	2019-04-04 00:34:23 +02:00
webpack.common.js	Replace js-url with wurl	2019-04-16 19:28:23 +02:00
webpack.dev.js
webpack.htmlexport.js
webpack.prod.js
yarn.lock	Update jQuery to version 3.4.1	2019-05-06 10:42:41 +02:00

README.md

CodiMD

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.

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.