mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-12-03 14:09:28 -05:00

HedgeDoc - Ideas grow better together

codimd collaboration hacktoberfest hedgedoc markdown notes real-time

Find a file

Yannick Bungers de09524658 Added Types and reformating code Signed-off-by: Yannick Bungers <git@innay.de> Signed-off-by: David Mehren <dmehren1@gmail.com>		2020-04-25 16:04:04 +02:00
bin	heroku complains about dialect	2020-01-11 23:51:52 +01:00
docs	Added config property for locales	2020-04-24 19:09:18 +02:00
lib	Added Types and reformating code	2020-04-25 16:04:04 +02:00
locales	Update sv.json (POEditor.com)	2020-02-17 00:01:08 +01:00
public	Fixed eslint error introduced by `2d3ea1f`	2020-04-24 03:15:19 +02:00
test	Update RevealJS to version 3.9.2	2020-02-01 12:53:15 +01:00
.babelrc
.editorconfig
.eslintignore	Use ESLint and 'typescript-eslint' plugin.	2020-04-25 16:04:03 +02:00
.eslintrc.js	Error on too many semicolons	2020-04-25 16:04:03 +02:00
.gitignore	Ignore the build directory from git	2020-02-24 15:46:22 +01:00
.mailmap
.sequelizerc.example
.travis.yml	Remove Tests for EOL node version 8	2020-02-16 23:41:28 +01:00
app.json	Remove PDF export	2020-02-26 15:05:54 +01:00
AUTHORS
CHANGELOG.md
CODE_OF_CONDUCT.md
config.json.example	Remove mattermost integration	2020-02-25 14:33:30 +01:00
CONTRIBUTING.md
LICENSE
package.json	Use ESLint and 'typescript-eslint' plugin.	2020-04-25 16:04:03 +02:00
README.md	Remove mattermost integration	2020-02-25 14:33:30 +01:00
SECURITY.md	Add security note to repository	2019-09-10 14:11:23 +02:00
tsconfig.json	tsconfig.json: Sequelize classes need ES6, debugging needs source maps	2020-04-25 16:04:02 +02:00
webpack.common.js	Add typescript dependency & tsconfig.json	2020-02-24 15:08:20 +01:00
webpack.dev.js
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 ESLint and 'typescript-eslint' plugin.	2020-04-25 16:04:03 +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, 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.