diff --git a/README.md b/README.md index ba1a374cc..94aa81e81 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ 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). -[![HedgeDoc 1.7.0 with its feature demonstration page open](docs/images/HedgeDoc-1.7.0-features.png)][hedgedoc-demo-features] +[![HedgeDoc 1.7.0 with its feature demonstration page open](public/screenshot.png)][hedgedoc-demo-features] ## Community and Contributions diff --git a/docs/configuration.md b/docs/content/configuration.md similarity index 98% rename from docs/configuration.md rename to docs/content/configuration.md index 438d84b32..f57d71789 100644 --- a/docs/configuration.md +++ b/docs/content/configuration.md @@ -4,9 +4,9 @@ You can choose to configure HedgeDoc with either a config file or with environme Environment variables take precedence over configurations from the config files. They generally start with `CMD_` for our own options, but we also list node-specific options you can configure this way. -- Environment variables are processed in [`lib/config/environment.js`](../lib/config/environment.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](../lib/config/default.js), in case you wonder if you even need to override it. +- Environment variables are processed in [`lib/config/environment.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/environment.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/default.js), in case you wonder if you even need to override it. -- The config file is processed in [`lib/config/index.js`](../lib/config/index.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](../lib/config/default.js), in case you wonder if you even need to override it. To get started, it is a good idea to take the `config.json.example` and copy it +- The config file is processed in [`lib/config/index.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/index.js) - so this is the first place to look if anything is missing not obvious from this document. The default values are defined in [`lib/config/default.js`](https://github.com/hedgedoc/hedgedoc/tree/master/lib/config/default.js), in case you wonder if you even need to override it. To get started, it is a good idea to take the `config.json.example` and copy it to `config.json` before filling in your own details. **Note:** *Due to the rename process we renamed all `HMD_`-prefix variables to be `CMD_`-prefixed. The old ones continue to work.* diff --git a/docs/dev/api.md b/docs/content/dev/api.md similarity index 96% rename from docs/dev/api.md rename to docs/content/dev/api.md index e89741d32..0700ecc36 100644 --- a/docs/dev/api.md +++ b/docs/content/dev/api.md @@ -11,14 +11,14 @@ You have to replace *\* with either the alias or id of a note you want to | ---------------------------------------------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `/new` | `GET` | **Creates a new note.**
A random id will be assigned and the content will equal to the template (blank by default). After note creation a redirect is issued to the created note. | | `/new` | `POST` | **Imports some markdown data into a new note.**
A random id will be assigned and the content will equal to the body of the received HTTP-request. The `Content-Type: text/markdown` header should be set on this request. | -| `/new/` | `POST` | **Imports some markdown data into a new note with a given alias.**
This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](../configuration-env-vars.md#users-and-privileges) is enabled. | +| `/new/` | `POST` | **Imports some markdown data into a new note with a given alias.**
This endpoint equals to the above one except that the alias from the url will be assigned to the note if [FreeURL-mode](../configuration.md#users-and-privileges) is enabled. | | `//download` or `/s//download` | `GET` | **Returns the raw markdown content of a note.** | | `//publish` | `GET` | **Redirects to the published version of the note.** | | `//slide` | `GET` | **Redirects to the slide-presentation of the note.**
This is only useful on notes which are designed to be slides. | | `//info` | `GET` | **Returns metadata about the note.**
This includes the title and description of the note as well as the creation date and viewcount. The data is returned as a JSON object. | | `//revision` | `GET` | **Returns a list of the available note revisions.**
The list is returned as a JSON object with an array of revision-id and length associations. The revision-id equals to the timestamp when the revision was saved. | | `//revision/` | `GET` | **Returns the revision of the note with some metadata.**
The revision is returned as a JSON object with the content of the note and the authorship. | -| `//gist` | `GET` | **Creates a new GitHub Gist with the note's content.**
If [GitHub integration](../configuration-env-vars.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created. | +| `//gist` | `GET` | **Creates a new GitHub Gist with the note's content.**
If [GitHub integration](../configuration.md#github-login) is configured, the user will be redirected to GitHub and a new Gist with the content of the note will be created. | ## User / History These endpoints return information about the current logged-in user and it's note history. If no user is logged-in, the most of this requests will fail with either a HTTP 403 or a JSON object containing `{"status":"forbidden"}`. diff --git a/docs/content/dev/documentation.md b/docs/content/dev/documentation.md new file mode 100644 index 000000000..0271792b1 --- /dev/null +++ b/docs/content/dev/documentation.md @@ -0,0 +1,27 @@ +# Documentation + +Our documentation is build with [mkdocs](https://www.mkdocs.org). + +## Writing + +All documentation files are found in the `docs/content` directory of the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with nothing special about them. + +The configuration for mkdocs lies in the `docs` folder in a file called `mkdocs.yml`. With that file the theme and menu - amoung others - can be configured. +**Please note:** Any new files need to be linked to by other files or put in the navigation or the files will be very hard to find on the documentation website. + +## Building + +To build the documentation locally you need to perform the following steps: + +0. Make sure you have python3 installed. +1. Go into the `docs` folder. +2. Install all the dependencies (E.g. with a [venv](https://docs.python.org/3/library/venv.html)) with `pip install -r requirements.txt` +3. Start the mkdocs dev server (`mkdocs serve`) or build the documentation (`mkdocs build`). + +## Deployment + +The documentation is deployed with [Messor Structor](https://github.com/traefik/structor). + +The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be found in the [docs.hedgedoc.org repo](https://github.com/hedgedoc/docs.hedgedoc.org). This repo is also used to deploy the actuall website to github.io. + +Messor Structor builds and deploys the documentation by finding all branches that follow the pattern `v*`. For each branch the docs are generated separately by first installing the dependencies from `requirements.txt` and then running mkdocs. Afterwards the menu go template is used to include a version switcher in the theme. diff --git a/docs/dev/getting-started.md b/docs/content/dev/getting-started.md similarity index 94% rename from docs/dev/getting-started.md rename to docs/content/dev/getting-started.md index b77871175..b7154b05f 100644 --- a/docs/dev/getting-started.md +++ b/docs/content/dev/getting-started.md @@ -11,8 +11,8 @@ and create configs. The setup script is written in Bash, you would need bash as a prerequisite. -3. Setup the [config file](../configuration-config-file.md) or set up - [environment variables](../configuration-env-vars.md). +3. Setup the [config file](../configuration.md) or set up + [environment variables](../configuration.md). ## Running the Code diff --git a/docs/dev/openapi.yml b/docs/content/dev/openapi.yml similarity index 100% rename from docs/dev/openapi.yml rename to docs/content/dev/openapi.yml diff --git a/docs/dev/ot.md b/docs/content/dev/ot.md similarity index 100% rename from docs/dev/ot.md rename to docs/content/dev/ot.md diff --git a/docs/dev/webpack.md b/docs/content/dev/webpack.md similarity index 100% rename from docs/dev/webpack.md rename to docs/content/dev/webpack.md diff --git a/docs/guides/auth/github.md b/docs/content/guides/auth/github.md similarity index 100% rename from docs/guides/auth/github.md rename to docs/content/guides/auth/github.md diff --git a/docs/guides/auth/gitlab-self-hosted.md b/docs/content/guides/auth/gitlab-self-hosted.md similarity index 100% rename from docs/guides/auth/gitlab-self-hosted.md rename to docs/content/guides/auth/gitlab-self-hosted.md diff --git a/docs/guides/auth/keycloak.md b/docs/content/guides/auth/keycloak.md similarity index 100% rename from docs/guides/auth/keycloak.md rename to docs/content/guides/auth/keycloak.md diff --git a/docs/guides/auth/ldap-ad.md b/docs/content/guides/auth/ldap-ad.md similarity index 100% rename from docs/guides/auth/ldap-ad.md rename to docs/content/guides/auth/ldap-ad.md diff --git a/docs/guides/auth/mattermost-self-hosted.md b/docs/content/guides/auth/mattermost-self-hosted.md similarity index 100% rename from docs/guides/auth/mattermost-self-hosted.md rename to docs/content/guides/auth/mattermost-self-hosted.md diff --git a/docs/guides/auth/nextcloud.md b/docs/content/guides/auth/nextcloud.md similarity index 100% rename from docs/guides/auth/nextcloud.md rename to docs/content/guides/auth/nextcloud.md diff --git a/docs/guides/auth/oauth.md b/docs/content/guides/auth/oauth.md similarity index 100% rename from docs/guides/auth/oauth.md rename to docs/content/guides/auth/oauth.md diff --git a/docs/guides/auth/saml-keycloak.md b/docs/content/guides/auth/saml-keycloak.md similarity index 100% rename from docs/guides/auth/saml-keycloak.md rename to docs/content/guides/auth/saml-keycloak.md diff --git a/docs/guides/auth/saml-onelogin.md b/docs/content/guides/auth/saml-onelogin.md similarity index 100% rename from docs/guides/auth/saml-onelogin.md rename to docs/content/guides/auth/saml-onelogin.md diff --git a/docs/guides/auth/saml.md b/docs/content/guides/auth/saml.md similarity index 100% rename from docs/guides/auth/saml.md rename to docs/content/guides/auth/saml.md diff --git a/docs/guides/auth/twitter.md b/docs/content/guides/auth/twitter.md similarity index 100% rename from docs/guides/auth/twitter.md rename to docs/content/guides/auth/twitter.md diff --git a/docs/guides/migrate-etherpad.md b/docs/content/guides/migrate-etherpad.md similarity index 100% rename from docs/guides/migrate-etherpad.md rename to docs/content/guides/migrate-etherpad.md diff --git a/docs/guides/migrations-and-breaking-changes.md b/docs/content/guides/migrations-and-breaking-changes.md similarity index 100% rename from docs/guides/migrations-and-breaking-changes.md rename to docs/content/guides/migrations-and-breaking-changes.md diff --git a/docs/guides/minio-image-upload.md b/docs/content/guides/minio-image-upload.md similarity index 100% rename from docs/guides/minio-image-upload.md rename to docs/content/guides/minio-image-upload.md diff --git a/docs/guides/providing-terms.md b/docs/content/guides/providing-terms.md similarity index 100% rename from docs/guides/providing-terms.md rename to docs/content/guides/providing-terms.md diff --git a/docs/guides/s3-image-upload.md b/docs/content/guides/s3-image-upload.md similarity index 97% rename from docs/guides/s3-image-upload.md rename to docs/content/guides/s3-image-upload.md index 740dec53b..3b0410669 100644 --- a/docs/guides/s3-image-upload.md +++ b/docs/content/guides/s3-image-upload.md @@ -70,7 +70,7 @@ } ``` -9. In additional to edit `config.json` directly, you could also try [environment variables](../configuration-env-vars.md). +9. In additional to edit `config.json` directly, you could also try [environment variables](../configuration.md). ## Related Tools diff --git a/docs/history.md b/docs/content/history.md similarity index 100% rename from docs/history.md rename to docs/content/history.md diff --git a/docs/images/auth/application-page.png b/docs/content/images/auth/application-page.png similarity index 100% rename from docs/images/auth/application-page.png rename to docs/content/images/auth/application-page.png diff --git a/docs/images/auth/create-oauth-app.png b/docs/content/images/auth/create-oauth-app.png similarity index 100% rename from docs/images/auth/create-oauth-app.png rename to docs/content/images/auth/create-oauth-app.png diff --git a/docs/images/auth/create-twitter-app.png b/docs/content/images/auth/create-twitter-app.png similarity index 100% rename from docs/images/auth/create-twitter-app.png rename to docs/content/images/auth/create-twitter-app.png diff --git a/docs/images/auth/gitlab-application-details.png b/docs/content/images/auth/gitlab-application-details.png similarity index 100% rename from docs/images/auth/gitlab-application-details.png rename to docs/content/images/auth/gitlab-application-details.png diff --git a/docs/images/auth/gitlab-new-application.png b/docs/content/images/auth/gitlab-new-application.png similarity index 100% rename from docs/images/auth/gitlab-new-application.png rename to docs/content/images/auth/gitlab-new-application.png diff --git a/docs/images/auth/gitlab-sign-in.png b/docs/content/images/auth/gitlab-sign-in.png similarity index 100% rename from docs/images/auth/gitlab-sign-in.png rename to docs/content/images/auth/gitlab-sign-in.png diff --git a/docs/images/auth/keycloak_add_client.png b/docs/content/images/auth/keycloak_add_client.png similarity index 100% rename from docs/images/auth/keycloak_add_client.png rename to docs/content/images/auth/keycloak_add_client.png diff --git a/docs/images/auth/keycloak_client_overview.png b/docs/content/images/auth/keycloak_client_overview.png similarity index 100% rename from docs/images/auth/keycloak_client_overview.png rename to docs/content/images/auth/keycloak_client_overview.png diff --git a/docs/images/auth/keycloak_clients_overview.png b/docs/content/images/auth/keycloak_clients_overview.png similarity index 100% rename from docs/images/auth/keycloak_clients_overview.png rename to docs/content/images/auth/keycloak_clients_overview.png diff --git a/docs/images/auth/keycloak_force_idformat.png b/docs/content/images/auth/keycloak_force_idformat.png similarity index 100% rename from docs/images/auth/keycloak_force_idformat.png rename to docs/content/images/auth/keycloak_force_idformat.png diff --git a/docs/images/auth/keycloak_idp_cert.png b/docs/content/images/auth/keycloak_idp_cert.png similarity index 100% rename from docs/images/auth/keycloak_idp_cert.png rename to docs/content/images/auth/keycloak_idp_cert.png diff --git a/docs/images/auth/keycloak_mapper_email.png b/docs/content/images/auth/keycloak_mapper_email.png similarity index 100% rename from docs/images/auth/keycloak_mapper_email.png rename to docs/content/images/auth/keycloak_mapper_email.png diff --git a/docs/images/auth/keycloak_mapper_overview.png b/docs/content/images/auth/keycloak_mapper_overview.png similarity index 100% rename from docs/images/auth/keycloak_mapper_overview.png rename to docs/content/images/auth/keycloak_mapper_overview.png diff --git a/docs/images/auth/keycloak_mapper_username.png b/docs/content/images/auth/keycloak_mapper_username.png similarity index 100% rename from docs/images/auth/keycloak_mapper_username.png rename to docs/content/images/auth/keycloak_mapper_username.png diff --git a/docs/images/auth/keycloak_saml_export_cert.png b/docs/content/images/auth/keycloak_saml_export_cert.png similarity index 100% rename from docs/images/auth/keycloak_saml_export_cert.png rename to docs/content/images/auth/keycloak_saml_export_cert.png diff --git a/docs/images/auth/keycloak_saml_export_cert_details.png b/docs/content/images/auth/keycloak_saml_export_cert_details.png similarity index 100% rename from docs/images/auth/keycloak_saml_export_cert_details.png rename to docs/content/images/auth/keycloak_saml_export_cert_details.png diff --git a/docs/images/auth/keycloak_saml_import_cert.png b/docs/content/images/auth/keycloak_saml_import_cert.png similarity index 100% rename from docs/images/auth/keycloak_saml_import_cert.png rename to docs/content/images/auth/keycloak_saml_import_cert.png diff --git a/docs/images/auth/keycloak_saml_import_cert_details.png b/docs/content/images/auth/keycloak_saml_import_cert_details.png similarity index 100% rename from docs/images/auth/keycloak_saml_import_cert_details.png rename to docs/content/images/auth/keycloak_saml_import_cert_details.png diff --git a/docs/images/auth/mattermost-enable-oauth2.png b/docs/content/images/auth/mattermost-enable-oauth2.png similarity index 100% rename from docs/images/auth/mattermost-enable-oauth2.png rename to docs/content/images/auth/mattermost-enable-oauth2.png diff --git a/docs/images/auth/mattermost-oauth-app-add.png b/docs/content/images/auth/mattermost-oauth-app-add.png similarity index 100% rename from docs/images/auth/mattermost-oauth-app-add.png rename to docs/content/images/auth/mattermost-oauth-app-add.png diff --git a/docs/images/auth/mattermost-oauth-app-done.png b/docs/content/images/auth/mattermost-oauth-app-done.png similarity index 100% rename from docs/images/auth/mattermost-oauth-app-done.png rename to docs/content/images/auth/mattermost-oauth-app-done.png diff --git a/docs/images/auth/mattermost-oauth-app-form.png b/docs/content/images/auth/mattermost-oauth-app-form.png similarity index 100% rename from docs/images/auth/mattermost-oauth-app-form.png rename to docs/content/images/auth/mattermost-oauth-app-form.png diff --git a/docs/images/auth/nextcloud-oauth2-1-settings.png b/docs/content/images/auth/nextcloud-oauth2-1-settings.png similarity index 100% rename from docs/images/auth/nextcloud-oauth2-1-settings.png rename to docs/content/images/auth/nextcloud-oauth2-1-settings.png diff --git a/docs/images/auth/nextcloud-oauth2-2-client-add.png b/docs/content/images/auth/nextcloud-oauth2-2-client-add.png similarity index 100% rename from docs/images/auth/nextcloud-oauth2-2-client-add.png rename to docs/content/images/auth/nextcloud-oauth2-2-client-add.png diff --git a/docs/images/auth/nextcloud-oauth2-3-clientid-secret.png b/docs/content/images/auth/nextcloud-oauth2-3-clientid-secret.png similarity index 100% rename from docs/images/auth/nextcloud-oauth2-3-clientid-secret.png rename to docs/content/images/auth/nextcloud-oauth2-3-clientid-secret.png diff --git a/docs/images/auth/onelogin-add-app.png b/docs/content/images/auth/onelogin-add-app.png similarity index 100% rename from docs/images/auth/onelogin-add-app.png rename to docs/content/images/auth/onelogin-add-app.png diff --git a/docs/images/auth/onelogin-copy-idp-metadata.png b/docs/content/images/auth/onelogin-copy-idp-metadata.png similarity index 100% rename from docs/images/auth/onelogin-copy-idp-metadata.png rename to docs/content/images/auth/onelogin-copy-idp-metadata.png diff --git a/docs/images/auth/onelogin-edit-app-name.png b/docs/content/images/auth/onelogin-edit-app-name.png similarity index 100% rename from docs/images/auth/onelogin-edit-app-name.png rename to docs/content/images/auth/onelogin-edit-app-name.png diff --git a/docs/images/auth/onelogin-edit-sp-metadata.png b/docs/content/images/auth/onelogin-edit-sp-metadata.png similarity index 100% rename from docs/images/auth/onelogin-edit-sp-metadata.png rename to docs/content/images/auth/onelogin-edit-sp-metadata.png diff --git a/docs/images/auth/onelogin-select-template.png b/docs/content/images/auth/onelogin-select-template.png similarity index 100% rename from docs/images/auth/onelogin-select-template.png rename to docs/content/images/auth/onelogin-select-template.png diff --git a/docs/images/auth/onelogin-use-dashboard.png b/docs/content/images/auth/onelogin-use-dashboard.png similarity index 100% rename from docs/images/auth/onelogin-use-dashboard.png rename to docs/content/images/auth/onelogin-use-dashboard.png diff --git a/docs/images/auth/register-oauth-application-form.png b/docs/content/images/auth/register-oauth-application-form.png similarity index 100% rename from docs/images/auth/register-oauth-application-form.png rename to docs/content/images/auth/register-oauth-application-form.png diff --git a/docs/images/auth/register-twitter-application.png b/docs/content/images/auth/register-twitter-application.png similarity index 100% rename from docs/images/auth/register-twitter-application.png rename to docs/content/images/auth/register-twitter-application.png diff --git a/docs/images/auth/twitter-app-confirmation.png b/docs/content/images/auth/twitter-app-confirmation.png similarity index 100% rename from docs/images/auth/twitter-app-confirmation.png rename to docs/content/images/auth/twitter-app-confirmation.png diff --git a/docs/images/auth/twitter-app-keys.png b/docs/content/images/auth/twitter-app-keys.png similarity index 100% rename from docs/images/auth/twitter-app-keys.png rename to docs/content/images/auth/twitter-app-keys.png diff --git a/docs/content/images/favicon.png b/docs/content/images/favicon.png new file mode 100644 index 000000000..80afec65c Binary files /dev/null and b/docs/content/images/favicon.png differ diff --git a/docs/content/images/hedgedoc_logo_horizontal.svg b/docs/content/images/hedgedoc_logo_horizontal.svg new file mode 100644 index 000000000..387e2c03f --- /dev/null +++ b/docs/content/images/hedgedoc_logo_horizontal.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/content/images/logo.svg b/docs/content/images/logo.svg new file mode 100644 index 000000000..8e4071ea6 --- /dev/null +++ b/docs/content/images/logo.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/images/minio-image-upload/create-bucket.png b/docs/content/images/minio-image-upload/create-bucket.png similarity index 100% rename from docs/images/minio-image-upload/create-bucket.png rename to docs/content/images/minio-image-upload/create-bucket.png diff --git a/docs/images/minio-image-upload/create-policy.png b/docs/content/images/minio-image-upload/create-policy.png similarity index 100% rename from docs/images/minio-image-upload/create-policy.png rename to docs/content/images/minio-image-upload/create-policy.png diff --git a/docs/images/minio-image-upload/default-view.png b/docs/content/images/minio-image-upload/default-view.png similarity index 100% rename from docs/images/minio-image-upload/default-view.png rename to docs/content/images/minio-image-upload/default-view.png diff --git a/docs/images/minio-image-upload/docker-logs.png b/docs/content/images/minio-image-upload/docker-logs.png similarity index 100% rename from docs/images/minio-image-upload/docker-logs.png rename to docs/content/images/minio-image-upload/docker-logs.png diff --git a/docs/images/minio-image-upload/open-edit-policy.png b/docs/content/images/minio-image-upload/open-edit-policy.png similarity index 100% rename from docs/images/minio-image-upload/open-edit-policy.png rename to docs/content/images/minio-image-upload/open-edit-policy.png diff --git a/docs/images/s3-image-upload/bucket-policy-editor.png b/docs/content/images/s3-image-upload/bucket-policy-editor.png similarity index 100% rename from docs/images/s3-image-upload/bucket-policy-editor.png rename to docs/content/images/s3-image-upload/bucket-policy-editor.png diff --git a/docs/images/s3-image-upload/bucket-property.png b/docs/content/images/s3-image-upload/bucket-property.png similarity index 100% rename from docs/images/s3-image-upload/bucket-property.png rename to docs/content/images/s3-image-upload/bucket-property.png diff --git a/docs/images/s3-image-upload/create-bucket.png b/docs/content/images/s3-image-upload/create-bucket.png similarity index 100% rename from docs/images/s3-image-upload/create-bucket.png rename to docs/content/images/s3-image-upload/create-bucket.png diff --git a/docs/images/s3-image-upload/custom-policy.png b/docs/content/images/s3-image-upload/custom-policy.png similarity index 100% rename from docs/images/s3-image-upload/custom-policy.png rename to docs/content/images/s3-image-upload/custom-policy.png diff --git a/docs/images/s3-image-upload/iam-user.png b/docs/content/images/s3-image-upload/iam-user.png similarity index 100% rename from docs/images/s3-image-upload/iam-user.png rename to docs/content/images/s3-image-upload/iam-user.png diff --git a/docs/images/s3-image-upload/review-policy.png b/docs/content/images/s3-image-upload/review-policy.png similarity index 100% rename from docs/images/s3-image-upload/review-policy.png rename to docs/content/images/s3-image-upload/review-policy.png diff --git a/docs/index.md b/docs/content/index.md similarity index 89% rename from docs/index.md rename to docs/content/index.md index fb6f2cb8d..df961b028 100644 --- a/docs/index.md +++ b/docs/content/index.md @@ -1,6 +1,6 @@ # Welcome to the HedgeDoc Documentation -![HedgeDoc Logo](images/hedgedoc_logo_horizontal.png) +![HedgeDoc Logo](images/hedgedoc_logo_horizontal.svg) HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive it by visiting our [HedgeDoc demo server][hedgedoc-demo]. @@ -16,4 +16,4 @@ If you have any questions that aren't answered here, feel free to ask us on [Mat [hedgedoc-history]: https://hedgedoc.org/history [hedgedoc-faq]: https://hedgedoc.org/faq [matrix.org-url]: https://chat.hedgedoc.org -[hedgedoc-community]: https://community.hedgedoc.org \ No newline at end of file +[hedgedoc-community]: https://community.hedgedoc.org diff --git a/docs/legal/developer-certificate-of-origin.txt b/docs/content/legal/developer-certificate-of-origin.txt similarity index 100% rename from docs/legal/developer-certificate-of-origin.txt rename to docs/content/legal/developer-certificate-of-origin.txt diff --git a/docs/setup/cloudron.md b/docs/content/setup/cloudron.md similarity index 100% rename from docs/setup/cloudron.md rename to docs/content/setup/cloudron.md diff --git a/docs/setup/docker-linuxserver.md b/docs/content/setup/docker-linuxserver.md similarity index 97% rename from docs/setup/docker-linuxserver.md rename to docs/content/setup/docker-linuxserver.md index 1f2597f6c..33302f55f 100644 --- a/docs/setup/docker-linuxserver.md +++ b/docs/content/setup/docker-linuxserver.md @@ -12,7 +12,7 @@ [LinuxServer.io](https://linuxserver.io) have created an Ubuntu-based multi-arch container image for x86-64, arm64 and armhf. -- It supports all the environment variables detailed in the [configuration documentation](../configuration-env-vars.md) to modify it according to your needs. +- It supports all the environment variables detailed in the [configuration documentation](../configuration.md) to modify it according to your needs. - It gets rebuilt on new releases from HedgeDoc and also weekly if necessary to update any other package changes in the underlying container, making it easy to keep your HedgeDoc instance up to date. - It also details how to easily [utilize Docker networking to reverse proxy](https://github.com/linuxserver/docker-hedgedoc/#application-setup) HedgeDoc using their [SWAG docker image](https://github.com/linuxserver/docker-swag) diff --git a/docs/setup/docker.md b/docs/content/setup/docker.md similarity index 100% rename from docs/setup/docker.md rename to docs/content/setup/docker.md diff --git a/docs/setup/heroku.md b/docs/content/setup/heroku.md similarity index 100% rename from docs/setup/heroku.md rename to docs/content/setup/heroku.md diff --git a/docs/setup/kubernetes.md b/docs/content/setup/kubernetes.md similarity index 100% rename from docs/setup/kubernetes.md rename to docs/content/setup/kubernetes.md diff --git a/docs/setup/manual-setup.md b/docs/content/setup/manual-setup.md similarity index 100% rename from docs/setup/manual-setup.md rename to docs/content/setup/manual-setup.md diff --git a/docs/setup/reverse-proxy.md b/docs/content/setup/reverse-proxy.md similarity index 100% rename from docs/setup/reverse-proxy.md rename to docs/content/setup/reverse-proxy.md diff --git a/docs/setup/yunohost.md b/docs/content/setup/yunohost.md similarity index 100% rename from docs/setup/yunohost.md rename to docs/content/setup/yunohost.md diff --git a/docs/slide-options.md b/docs/content/slide-options.md similarity index 100% rename from docs/slide-options.md rename to docs/content/slide-options.md diff --git a/docs/content/theme/styles/hedgedoc-color.css b/docs/content/theme/styles/hedgedoc-color.css new file mode 100644 index 000000000..084a2bac7 --- /dev/null +++ b/docs/content/theme/styles/hedgedoc-color.css @@ -0,0 +1,14 @@ +[data-md-color-primary=hedgedoc] { + --md-primary-fg-color: #b51f08; + --md-primary-fg-color--light: #b51f08; + --md-primary-fg-color--dark: #b51f08; + --md-primary-bg-color: hsla(0, 0%, 100%, 1); + --md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7); +} + +[data-md-color-accent=hedgedoc] { + --md-accent-fg-color: #b51f08; + --md-accent-fg-color--transparent: hsla(348, 100%, 55%, 0.1); + --md-accent-bg-color: hsla(0, 0%, 100%, 1); + --md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7); +} diff --git a/docs/url-scheme.md b/docs/content/url-scheme.md similarity index 100% rename from docs/url-scheme.md rename to docs/content/url-scheme.md diff --git a/docs/dev/documentation.md b/docs/dev/documentation.md deleted file mode 100644 index aa3c52535..000000000 --- a/docs/dev/documentation.md +++ /dev/null @@ -1,27 +0,0 @@ -# Documentation - -Our documentation is build with [mkdocs](https://www.mkdocs.org). - -## Writing - -All documentation files are found in the `docs` directory of the [hedgedoc/hedgedoc repo](https://github.com/hedgedoc/hedgedoc). These files are just normal markdown files with nothing special about them. - -The config file for mkdocs lies in the root of the repo in a file called `mkdocs.yml`. With that file the theme and menu - amoung others - can be configured. -**Please note:** Any new files need to be linked to by other files or put in the navigation or the files will be very hard to find on the documentation website. - -## Building - -To build the documentation locally you need to perform the following steps: - -1. make sure you have python3 installed -2. install all the dependencies possibly with a [venv](https://docs.python.org/3/library/venv.html): -`pip install -r mkdocs.requirements.txt` -3. start the mkdocs dev server `mkdocs serve` or let it build the documentation `mkdocs build` - -## Deployment - -The documentation is deployed with [Messor Structor](https://github.com/traefik/structor). - -The necessary Dockerfile and version menu template and also the github action to build the whole documentation can be found in the [docs.hedgedoc.org repo](https://github.com/hedgedoc/docs.hedgedoc.org). This repo is also used to deploy the actuall website to github.io. - -Messor Structor builds and deploys the documentation by finding all branches that follow the pattern `v*` and build each one seperatly via `mkdocs` by first installing `mkdocs.requirements.txt` and then building. Afterwards the menu go template is used to include a version switcher in the theme and make all the different versions available. \ No newline at end of file diff --git a/docs/images/HedgeDoc-1.7.0-features.png b/docs/images/HedgeDoc-1.7.0-features.png deleted file mode 120000 index c29ae1dff..000000000 --- a/docs/images/HedgeDoc-1.7.0-features.png +++ /dev/null @@ -1 +0,0 @@ -../../public/screenshot.png \ No newline at end of file diff --git a/docs/images/favicon.png b/docs/images/favicon.png deleted file mode 120000 index 2b0c8015a..000000000 --- a/docs/images/favicon.png +++ /dev/null @@ -1 +0,0 @@ -../../public/icons/favicon-32x32.png \ No newline at end of file diff --git a/docs/images/hedgedoc_logo_horizontal.png b/docs/images/hedgedoc_logo_horizontal.png deleted file mode 100644 index 012714243..000000000 Binary files a/docs/images/hedgedoc_logo_horizontal.png and /dev/null differ diff --git a/docs/images/logo.png b/docs/images/logo.png deleted file mode 120000 index 22e855a96..000000000 --- a/docs/images/logo.png +++ /dev/null @@ -1 +0,0 @@ -../../public/icons/android-chrome-512x512.png \ No newline at end of file diff --git a/mkdocs.yml b/docs/mkdocs.yml similarity index 92% rename from mkdocs.yml rename to docs/mkdocs.yml index 562f87ff2..a403cd3b6 100644 --- a/mkdocs.yml +++ b/docs/mkdocs.yml @@ -3,6 +3,7 @@ site_url: https://docs.hedgedoc.org repo_url: https://github.com/hedgedoc/hedgedoc site_description: 'HedgeDoc Documentation' site_author: 'HedgeDoc Developers' +docs_dir: content nav: - Home: index.md - Installation: @@ -46,12 +47,15 @@ theme: name: 'material' language: en favicon: images/favicon.png - logo: images/logo.png + logo: images/logo.svg palette: - scheme: preference - primary: 'red' - accent: 'red' + scheme: light + primary: 'hedgedoc' + accent: 'hedgedoc' features: - navigation.tabs - navigation.sections - toc.integrate + +extra_css: + - theme/styles/hedgedoc-color.css diff --git a/mkdocs.requirements.txt b/docs/requirements.txt similarity index 100% rename from mkdocs.requirements.txt rename to docs/requirements.txt