mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2024-11-25 19:26:31 -05:00
[Docs] Add "getting started" page
Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de>
This commit is contained in:
parent
18de2e7954
commit
63b50651df
3 changed files with 33 additions and 9 deletions
10
docs/content/setup/getting-started.md
Normal file
10
docs/content/setup/getting-started.md
Normal file
|
@ -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.
|
|
@ -12,6 +12,15 @@
|
||||||
--md-accent-bg-color: hsla(0, 0%, 100%, 1);
|
--md-accent-bg-color: hsla(0, 0%, 100%, 1);
|
||||||
--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
|
--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7);
|
||||||
}
|
}
|
||||||
|
|
||||||
.md-grid {
|
.md-grid {
|
||||||
max-width: 1440px;
|
max-width: 1440px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.twitter {
|
||||||
|
color: #1DA1F2;
|
||||||
|
}
|
||||||
|
|
||||||
|
.mastodon {
|
||||||
|
color: #2b90d9;
|
||||||
|
}
|
||||||
|
|
|
@ -8,6 +8,7 @@ edit_uri: https://github.com/hedgedoc/hedgedoc/edit/master/docs/content/
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Installation:
|
- Installation:
|
||||||
|
- 'Getting Started': setup/getting-started.md
|
||||||
- Official installation methods:
|
- Official installation methods:
|
||||||
- 'Docker Image': setup/docker.md
|
- 'Docker Image': setup/docker.md
|
||||||
- 'Manual Installation': setup/manual-setup.md
|
- 'Manual Installation': setup/manual-setup.md
|
||||||
|
@ -51,6 +52,10 @@ markdown_extensions:
|
||||||
- pymdownx.highlight
|
- pymdownx.highlight
|
||||||
- pymdownx.superfences
|
- pymdownx.superfences
|
||||||
- mdx_truly_sane_lists
|
- mdx_truly_sane_lists
|
||||||
|
- pymdownx.emoji:
|
||||||
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
|
- attr_list
|
||||||
theme:
|
theme:
|
||||||
name: 'material'
|
name: 'material'
|
||||||
language: en
|
language: en
|
||||||
|
|
Loading…
Reference in a new issue