mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-26 22:41:00 +00:00

HedgeDoc - Ideas grow better together

codimd collaboration hacktoberfest hedgedoc markdown notes real-time

Find a file

Sheogorath 651db60985 Update CDN defaults As we noticed in our poll about CDN usage, that most people intentionally turn it off, but very little intetionally turn it on or leave it on. [1] There is also strong indicators that CDNs don't really provide any benefits in loading time and due to the small deployments of CodiMD, there is no big savings due to CDNs either. [2] Therefore this patch changes the CDN default settings to off in order to reduce the exposed user data. [1]: https://community.codimd.org/t/poll-on-cdn-usage/28 [2]: https://csswizardry.com/2019/05/self-host-your-static-assets/ Signed-off-by: Sheogorath <sheogorath@shivering-isles.com>		2020-02-09 21:59:17 +01:00
bin
docs	Update CDN defaults	2020-02-09 21:59:17 +01:00
lib	Update CDN defaults	2020-02-09 21:59:17 +01:00
locales
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
.editorconfig
.eslintignore
.eslintrc.js
.gitignore
.mailmap
.sequelizerc.example
.travis.yml
app.js
app.json	Update app.json	2020-02-08 15:57:35 +08:00
AUTHORS
CHANGELOG.md
CODE_OF_CONDUCT.md
config.json.example
CONTRIBUTING.md
LICENSE
package.json	Update RevealJS to version 3.9.2	2020-02-01 12:53:15 +01:00
README.md
SECURITY.md
webpack.common.js	Update RevealJS to version 3.9.2	2020-02-01 12:53:15 +01:00
webpack.dev.js
webpack.htmlexport.js
webpack.prod.js
yarn.lock	Update yarn.lock	2020-02-09 14:34:28 +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.