Merge pull request #829 from hedgedoc/getting-started-page

[Docs] Add "getting started" page
This commit is contained in:
David Mehren 2021-02-03 23:02:32 +01:00 committed by GitHub
commit a4f7b51292
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 9 deletions

View 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.

View file

@ -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;
}

View file

@ -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