mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-22 09:46:30 -05:00

HedgeDoc - Ideas grow better together

codimd collaboration hacktoberfest hedgedoc markdown notes real-time

Find a file

Erik Michelson d9adf598d8 Add dropbox CSP directive if configured and make button clickable The lack of a 'preventDefault' on the click event handler resulted in the dropbox link being unclickable. Furthermore because of a missing CSP rule, the dropbox script couldn't be loaded. The dropbox origin is now added to the CSP script sources if dropbox integration is configured. Signed-off-by: Erik Michelson <github@erik.michelson.eu>		2020-08-23 01:11:31 +02:00
bin	Fixed eslint errors (whitespaces)	2020-03-21 23:27:00 +01:00
docs	feat: add default values to configuration documentation	2020-08-04 19:03:42 +02:00
lib	Add dropbox CSP directive if configured and make button clickable	2020-08-23 01:11:31 +02:00
locales	Added translation keys for changed and created	2020-08-14 00:05:28 +02:00
public	Add dropbox CSP directive if configured and make button clickable	2020-08-23 01:11:31 +02: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
.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
.travis.yml	chore: add markdown linter in travis CI	2020-07-02 11:55:44 +02:00
app.js	Relax cookie restrictions to 'lax' to allow frontend to work	2020-06-10 15:16:32 +02:00
app.json	Update app.json	2020-02-08 15:57:35 +08: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	also use gfm header generation in test and debug configuraitons	2019-10-30 17:46:31 +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	Update copy-webpack-plugin, css-loader, html-webpack-plugin, style-loader, webpack and webpack-cli	2020-08-19 19:40:17 +02:00
README.md	Merge pull request #461 from SISheogorath/docs/add-renaming-note	2020-07-30 21:31:25 +02:00
SECURITY.md	Add security note to repository	2019-09-10 14:11:23 +02:00
webpack.common.js	Update copy-webpack-plugin, css-loader, html-webpack-plugin, style-loader, webpack and webpack-cli	2020-08-19 19:40:17 +02: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	Update copy-webpack-plugin, css-loader, html-webpack-plugin, style-loader, webpack and webpack-cli	2020-08-19 19:40:17 +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.

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.

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.