diff options
| -rw-r--r-- | README.md | 30 |
1 files changed, 20 insertions, 10 deletions
@@ -12,7 +12,7 @@ it by visiting our [HedgeDoc demo server][hedgedoc-demo]. It is inspired by Hackpad, Etherpad and similar collaborative editors. This project originated with the team at [HackMD](https://hackmd.io) and now forked -into its own organisation. [A longer writeup can be read in the history doc](docs/history.md). +into its own organisation. [A longer writeup can be read in the history][history]. [][hedgedoc-demo-features] @@ -21,7 +21,7 @@ into its own organisation. [A longer writeup can be read in the history doc](doc We welcome contributions! There's a lot to do: If you would like to report bugs, the [issue tracker][github-issue-tracker] is the right place. If you can help translating, find us on [POEditor][poeditor-url]. To get started developing, -take a look at the [docs/dev](docs/dev) directory. In any case: come talk to us, +take a look at the [developer documentation][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 @@ -34,20 +34,20 @@ regular [community calls][hedgedoc-community-calls] ([RSS](https://community.hed You can run HedgeDoc in a number of ways, and we created setup instructions for all of these: -- [Docker](docs/setup/docker.md) -- [Cloudron](docs/setup/cloudron.md) -- [LinuxServer.io (multi-arch docker)](docs/setup/docker-linuxserver.md) -- [Heroku](docs/setup/heroku.md) -- [Manual setup](docs/setup/manual-setup.md) +- [Docker][setup-docker] +- [Cloudron][setup-cloudron] +- [LinuxServer.io (multi-arch docker)][setup-docker-linuxserver] +- [Heroku][setup-heroku] +- [Manual setup][setup-manual] ## Configuration -Theres two main ways to [configure](docs/configuration.md) your HedgeDoc instance: +Theres two main ways to [configure][configuration] 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](docs/guides/auth/oauth.md) **for login** +- facebook, twitter, github, gitlab, mattermost, dropbox, google, ldap, saml and [oauth2][configuration-oauth] **for login** - imgur, s3, minio, azure **for image/attachment storage** (files can also be local!) - dropbox **for export and import** @@ -72,7 +72,7 @@ To backup HedgeDoc, you should: - backup your database - backup your custom config file if you have one -- backup the upload folder (see the [uploadsPath](./docs/configuration.md#hedgedoc-paths-stuff) config directive) +- backup the upload folder (see the [uploadsPath][configuration-paths] config directive) Restoring an existing instance of HedgeDoc is then just a matter of restoring these elements. @@ -87,6 +87,16 @@ Licensed under AGPLv3. For our list of contributors, see [AUTHORS](AUTHORS). The license does not include the HedgeDoc logo, whose terms of usage can be found in the [github repository](https://github.com/hedgedoc/hedgedoc-logo). +[configuration-oauth]: https://docs.hedgedoc.org/configuration/#oauth2-login +[configuration]: https://docs.hedgedoc.org/configuration/ +[configuration-paths]: https://docs.hedgedoc.org/configuration/#hedgedoc-paths-stuff +[setup-docker]: https://docs.hedgedoc.org/setup/docker/ +[setup-cloudron]: https://docs.hedgedoc.org/setup/cloudron/ +[setup-docker-linuxserver]: https://docs.hedgedoc.org/setup/docker-linuxserver/ +[setup-heroku]: https://docs.hedgedoc.org/setup/heroku/ +[setup-manual]: https://docs.hedgedoc.org/setup/manual-setup/ +[developer-documentation]: https://docs.hedgedoc.org/dev/getting-started/ +[history]: https://hedgedoc.org/history [matrix.org-image]: https://img.shields.io/matrix/hedgedoc:matrix.org?logo=matrix&server_fqdn=matrix.org [matrix.org-url]: https://chat.hedgedoc.org [github-version-badge]: https://img.shields.io/github/release/hedgedoc/hedgedoc.svg |