diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/guides/reverse-proxy.md (renamed from docs/content/setup/reverse-proxy.md) | 0 | ||||
-rw-r--r-- | docs/content/setup/arch-linux.md | 5 | ||||
-rw-r--r-- | docs/content/setup/getting-started.md | 10 | ||||
-rw-r--r-- | docs/content/setup/index.md | 8 | ||||
-rw-r--r-- | docs/content/setup/kubernetes-helm.md | 7 | ||||
-rw-r--r-- | docs/content/setup/kubernetes.md | 5 | ||||
-rw-r--r-- | docs/content/theme/styles/hedgedoc-custom.css | 27 | ||||
-rw-r--r-- | docs/mkdocs.yml | 23 | ||||
-rw-r--r-- | docs/requirements.txt | 4 |
9 files changed, 58 insertions, 31 deletions
diff --git a/docs/content/setup/reverse-proxy.md b/docs/content/guides/reverse-proxy.md index b1e7f32f..b1e7f32f 100644 --- a/docs/content/setup/reverse-proxy.md +++ b/docs/content/guides/reverse-proxy.md diff --git a/docs/content/setup/arch-linux.md b/docs/content/setup/arch-linux.md new file mode 100644 index 00000000..1ffcabf2 --- /dev/null +++ b/docs/content/setup/arch-linux.md @@ -0,0 +1,5 @@ +# Arch Linux + +HedgeDoc is available in the Arch Linux _community_ repository. + +[Link to the package](https://archlinux.org/packages/community/any/hedgedoc/) diff --git a/docs/content/setup/getting-started.md b/docs/content/setup/getting-started.md new file mode 100644 index 00000000..41426514 --- /dev/null +++ b/docs/content/setup/getting-started.md @@ -0,0 +1,10 @@ +# Getting started + +Thank you for choosing HedgeDoc! +To set up your instance follow these steps: + +1. Choose an installation method and follow the instructions +2. [Configure your reverse proxy](https://docs.hedgedoc.org/guides/reverse-proxy/) +3. [Configure HedgeDoc](https://docs.hedgedoc.org/configuration/) + +Follow us on <a href="http://social.codimd.org/" target="_blank" rel="noreferer noopener">:fontawesome-brands-mastodon:{: .mastodon }Mastodon</a> or <a href="http://social.codimd.org/twitter" target="_blank" rel="noreferer noopener">:fontawesome-brands-twitter:{: .twitter }Twitter</a> for updates. diff --git a/docs/content/setup/index.md b/docs/content/setup/index.md deleted file mode 100644 index 253450b7..00000000 --- a/docs/content/setup/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Installation / Upgrading -You can run HedgeDoc in a number of ways: - -- [Docker](docker) -- [Cloudron](cloudron) -- [LinuxServer.io (multi-arch docker)](docker-linuxserver) -- [Heroku](heroku) -- [Manual setup](manual-setup) diff --git a/docs/content/setup/kubernetes-helm.md b/docs/content/setup/kubernetes-helm.md new file mode 100644 index 00000000..67a27e82 --- /dev/null +++ b/docs/content/setup/kubernetes-helm.md @@ -0,0 +1,7 @@ +# Helm Chart + +You can deploy HedgeDoc on your Kubernetes cluster using `helm`. + +[HedgeDoc Helm Chart by nicholaswilde on Artifact Hub](https://artifacthub.io/packages/helm/nicholaswilde/hedgedoc) + +[Source Code](https://nicholaswilde.github.io/helm-charts/) diff --git a/docs/content/setup/kubernetes.md b/docs/content/setup/kubernetes.md deleted file mode 100644 index 7ece0d20..00000000 --- a/docs/content/setup/kubernetes.md +++ /dev/null @@ -1,5 +0,0 @@ -# Kubernetes - -HedgeDoc currently does not support any deployment via Kubernetes. - -If you want to help us creating a helm chart, then feel free to contact us on [Matrix](https://chat.hedgedoc.org/) or [Discourse](https://community.hedgedoc.org/). diff --git a/docs/content/theme/styles/hedgedoc-custom.css b/docs/content/theme/styles/hedgedoc-custom.css index 54e18919..e3c52757 100644 --- a/docs/content/theme/styles/hedgedoc-custom.css +++ b/docs/content/theme/styles/hedgedoc-custom.css @@ -1,17 +1,26 @@ [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); + --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); + --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); } + .md-grid { max-width: 1440px; } + +.twitter { + color: #1DA1F2; +} + +.mastodon { + color: #2b90d9; +} diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index dcdd531a..f0dfb723 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -8,14 +8,19 @@ edit_uri: https://github.com/hedgedoc/hedgedoc/edit/master/docs/content/ nav: - Home: index.md - Installation: - - 'Manual Installation': setup/manual-setup.md - - 'Reverse Proxy': setup/reverse-proxy.md - - Docker: setup/docker.md - - Cloudron: setup/cloudron.md - - Heroku: setup/heroku.md - - LinuxServer: setup/docker-linuxserver.md - - Yunohost: setup/yunohost.md + - 'Getting Started': setup/getting-started.md + - Official installation methods: + - 'Docker Image': setup/docker.md + - 'Manual Installation': setup/manual-setup.md + - Heroku: setup/heroku.md + - Community installation methods: + - 'LinuxServer Docker Image': setup/docker-linuxserver.md + - 'Helm Chart': setup/kubernetes-helm.md + - 'YunoHost App': setup/yunohost.md + - 'Cloudron App': setup/cloudron.md + - 'Arch Linux Package': setup/arch-linux.md - Guides: + - 'Reverse Proxy': guides/reverse-proxy.md - Authentication: - LDAP: guides/auth/ldap-ad.md - OAuth: guides/auth/oauth.md @@ -47,6 +52,10 @@ markdown_extensions: - pymdownx.highlight - pymdownx.superfences - mdx_truly_sane_lists + - pymdownx.emoji: + emoji_index: !!python/name:materialx.emoji.twemoji + emoji_generator: !!python/name:materialx.emoji.to_svg + - attr_list theme: name: 'material' language: en diff --git a/docs/requirements.txt b/docs/requirements.txt index 043febc1..1f025c14 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ mkdocs==1.1.2 -mkdocs-material==6.2.3 -pymdown-extensions==8.1 +mkdocs-material==6.2.8 +pymdown-extensions==8.1.1 mdx_truly_sane_lists==1.2 |