mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 01:36:29 -05:00

HedgeDoc - Ideas grow better together

codimd collaboration hacktoberfest hedgedoc markdown notes real-time

Find a file

Sheogorath b3d4cdbceb Update RevealJS to version 3.9.2 This update of revealJS helps us to get rid of the headjs depedency integration using webpack. It updates reveal.js to 3.9.2 and updates the csp hash accordingly for using the slide mode. Background for this update is the critical security vulnerability described by snyk in their disclosure: https://snyk.io/vuln/SNYK-JS-REVEALJS-543841 Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>		2020-02-01 12:53:15 +01:00
bin	heroku complains about dialect	2020-01-11 23:51:52 +01:00
docs	update env docs in reference to #247	2020-01-16 17:25:41 -05:00
lib	Update RevealJS to version 3.9.2	2020-02-01 12:53:15 +01:00
locales	Update sv.json (POEditor.com)	2019-11-20 20:07:02 +01:00
public	Changed Gravatar to Libravatar in privacy-template	2020-01-23 00:19:25 +01:00
test	Update RevealJS to version 3.9.2	2020-02-01 12:53:15 +01: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
.sequelizerc.example	Create example config	2016-10-05 10:58:05 +08:00
.travis.yml	travis config is now in stages	2019-05-13 19:37:22 +02:00
app.js	Move note actions to their own file.	2019-10-27 13:51:53 +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
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	also use gfm header generation in test and debug configuraitons	2019-10-30 17:46:31 +01:00
CONTRIBUTING.md	Move DCO into docs section	2019-06-10 17:35:36 +02:00
LICENSE	Fix LICENSE content	2019-03-31 03:27:12 +02:00
package.json	Update RevealJS to version 3.9.2	2020-02-01 12:53:15 +01:00
README.md	Update badge icons	2019-08-03 17:57:47 +02:00
SECURITY.md	Add security note to repository	2019-09-10 14:11:23 +02:00
webpack.common.js	Update RevealJS to version 3.9.2	2020-02-01 12:53:15 +01:00
webpack.dev.js	Use webpack-merge.	2018-10-10 22:09:46 +02: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	Upgrade webpack & plugins	2019-11-23 18:11:17 +01: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.