HedgeDoc - Ideas grow better together
Find a file
Erik Michelson 40d30baa03
Improved CSS in night-mode
A general invert-filter is applied to all pre elements in night mode. As diagrams are embedded inside pre tags, they're inverted as well. For sequence-diagrams and flow-charts this looks well, if we wouldn't additionally set the stroke and text color to white in night-mode. These additional white rules invert the already inverted diagram again and make it not good visible. The graphviz and abc embeddings aren't really optimized to be inverted, therefore they're now excluded from invertion and stay in day mode.

Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2021-01-28 12:30:47 +01:00
.github Update issue templates to use the new labels 2020-12-01 21:14:11 +01:00
bin Fix inconsistent spacing in bin/setup 2020-11-17 21:29:54 +01:00
docs Keep JS and env varibale name in sync (requireFreeURLAuthentication) 2021-01-23 14:14:47 +01:00
lib Don't add new config option in hackmd compatibility layer 2021-01-23 16:20:03 +01:00
locales Update el.json (POEditor.com) 2020-11-27 21:52:47 +01:00
public Improved CSS in night-mode 2021-01-28 12:30:47 +01:00
test Add test for dropbox csp rule 2020-08-23 01:41:55 +02:00
.babelrc drop node 6 support 2019-05-13 19:37:21 +02:00
.editorconfig Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01: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 added documentation about how the write, build and deploy this 2021-01-04 14:26:39 +01:00
.mailmap Update .mailmap and AUTHORS 2020-11-27 22:23:08 +01: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
app.js Remove pdf export code 2020-11-26 21:09:23 +01:00
app.json Remove pdf export code 2020-11-26 21:09:23 +01:00
AUTHORS Update .mailmap and AUTHORS 2020-11-27 22:23:08 +01:00
CHANGELOG.md Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
CODE-OF-CONDUCT.md style: linting markdown files 2020-07-10 18:57:59 +02:00
config.json.example Replace CodiMD with HedgeDoc 2020-11-14 21:18:36 +01:00
CONTRIBUTING.md Fix link to DCO in contributing docs 2021-01-22 18:10:47 +01:00
LICENSE Replace slogan 2020-11-14 22:23:18 +01:00
package.json Bump version to 1.7.2 2021-01-15 20:37:30 +01:00
README.md Change history link 2021-01-05 17:18:45 +01:00
renovate.json Change label used by renovate to "type: maintenance" 2020-11-30 18:24:43 +01:00
SECURITY.md Replace references to Matrix room with chat.hedgedoc.org 2020-11-27 19:53:26 +01:00
webpack.common.js Generate CSS filenames with contenthash 2020-12-21 12:31:34 +01:00
webpack.dev.js Use new source map naming for the Webpack dev config 2020-11-10 22:56:00 +01: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 Regenerate yarn.lock 2021-01-14 23:31:53 +01:00

HedgeDoc Logo

HedgeDoc

#HedgeDoc on matrix.org version POEditor Mastodon

HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive it by visiting our HedgeDoc 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.

HedgeDoc 1.7.0 with its feature demonstration page open

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 developer documentation. 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 HedgeDoc in a number of ways, and we created setup instructions for all of these:

Configuration

Theres two main ways to configure your HedgeDoc instance: config file or environment variables. You can choose what works best for you.

HedgeDoc 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.

Browser support

To use HedgeDoc, your browser should match or exceed these versions:

  • Chrome Chrome >= 47, Chrome Chrome for Android >= 47
  • Safari Safari >= 9, iOS Safarai iOS Safari >= 8.4
  • Firefox Firefox >= 44
  • Edge Edge >= 12
  • Opera Opera >= 34, Opera Mini Opera Mini not supported
  • Android Browser Android Browser >= 4.4

Backup/restore your instance

To backup HedgeDoc, you should:

  • backup your database
  • backup your custom config file if you have one
  • backup the upload folder (see the uploadsPath config directive)

Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements.

Our community has created related tools, we'd like to highlight hedgedoc-cli which lets you use HedgeDoc from the comfort of your command line.

License

Licensed under AGPLv3. For our list of contributors, see AUTHORS.

The license does not include the HedgeDoc logo, whose terms of usage can be found in the github repository.