diff options
| author | Tilman Vatteroth | 2021-02-03 21:42:49 +0100 |
|---|---|---|
| committer | Tilman Vatteroth | 2021-02-03 21:42:49 +0100 |
| commit | 63b50651df7b3b2560b924d3afab995bceea3a82 (patch) | |
| tree | db1b1bb8de1222b503b4a2d9dc435c996d2afb68 /docs | |
| parent | 18de2e795450b29bfd0b4416c54ce191c96ace0d (diff) | |
[Docs] Add "getting started" page
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/setup/getting-started.md | 10 | ||||
| -rw-r--r-- | docs/content/theme/styles/hedgedoc-custom.css | 27 | ||||
| -rw-r--r-- | docs/mkdocs.yml | 5 |
3 files changed, 33 insertions, 9 deletions
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/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 6179bd68..f0dfb723 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -8,6 +8,7 @@ edit_uri: https://github.com/hedgedoc/hedgedoc/edit/master/docs/content/ nav: - Home: index.md - Installation: + - 'Getting Started': setup/getting-started.md - Official installation methods: - 'Docker Image': setup/docker.md - 'Manual Installation': setup/manual-setup.md @@ -51,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 |