mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-11-25 11:16:31 -05:00

HedgeDoc - Ideas grow better together

codimd collaboration hacktoberfest hedgedoc markdown notes real-time

Find a file

David Mehren db15afcb88 Define a MediaBackend interface This interface defines the functionality that all media backends (like S3 or Azure) must implement. Signed-off-by: David Mehren <git@herrmehren.de>		2020-10-16 22:29:13 +02:00
docs	DB Schema: Add MediaUpload entity	2020-10-13 10:19:12 +02:00
src	Define a MediaBackend interface	2020-10-16 22:29:13 +02:00
test/public-api	Collect coverage information for E2E tests	2020-10-03 18:00:12 +02:00
.editorconfig	Import meta-files	2022-01-23 22:02:58 +01:00
.eslintrc.js	Use default NestJS lint config	2020-07-24 21:47:41 +02:00
.gitignore	Add dist folder and coverage foldert to .gitignore	2020-07-25 20:31:07 +02:00
.mailmap	Import meta-files	2022-01-23 22:02:58 +01:00
.prettierrc	Use default NestJS lint config	2020-07-24 21:47:41 +02:00
AUTHORS	Import meta-files	2022-01-23 22:02:58 +01:00
CHANGELOG.md	Import meta-files	2022-01-23 22:02:58 +01:00
CODE_OF_CONDUCT.md	Import meta-files	2022-01-23 22:02:58 +01:00
CONTRIBUTING.md	Import meta-files	2022-01-23 22:02:58 +01:00
jest-e2e.json	Collect coverage information for E2E tests	2020-10-03 18:00:12 +02:00
LICENSE	Import meta-files	2022-01-23 22:02:58 +01:00
nest-cli.json	Enable automatic OpenAPI spec generation.	2020-07-26 16:53:43 +02:00
package.json	Collect coverage information for E2E tests	2020-10-03 18:00:12 +02:00
README.md	Warn about develop branch in README	2020-08-12 19:50:55 +02:00
SECURITY.md	Import meta-files	2022-01-23 22:02:58 +01:00
tsconfig.build.json	Add empty NestJS application	2020-07-21 21:24:56 +02:00
tsconfig.json	Import meta-files	2022-01-23 22:02:58 +01:00
yarn.lock	NotesController: Use custom logic to access raw markdown	2020-09-19 14:51:12 +02:00

README.md

HedgeDoc

Warning: The `develop` branch contains unstable code. Not suitable for production use! See here for development documentation.

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.