summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPhilip Molares2021-01-03 22:15:12 +0100
committerPhilip Molares2021-01-03 22:15:12 +0100
commit0911bf96e96c6bd4afefe4be58da3d63e2e2c226 (patch)
tree5592e58bc854c40f2ce2c341f9b4dca674a38f0a /docs
parent55d653a1a2046dcc90f675c75e0a2aa4164e6a86 (diff)
added all necessary configs to use structor
see https://github.com/traefik/structor Signed-off-by: Philip Molares <philip.molares@udo.edu>
Diffstat (limited to 'docs')
-rw-r--r--docs/guides/index.md3
l---------docs/images/favicon.png1
l---------docs/images/logo.png1
-rw-r--r--docs/index.md20
4 files changed, 18 insertions, 7 deletions
diff --git a/docs/guides/index.md b/docs/guides/index.md
deleted file mode 100644
index 25d4d949..00000000
--- a/docs/guides/index.md
+++ /dev/null
@@ -1,3 +0,0 @@
-## Guides
-
-In this section we try to provide you with some step-by-step guides for common scenarios to configure HedgeDoc to your needs.
diff --git a/docs/images/favicon.png b/docs/images/favicon.png
new file mode 120000
index 00000000..2b0c8015
--- /dev/null
+++ b/docs/images/favicon.png
@@ -0,0 +1 @@
+../../public/icons/favicon-32x32.png \ No newline at end of file
diff --git a/docs/images/logo.png b/docs/images/logo.png
new file mode 120000
index 00000000..22e855a9
--- /dev/null
+++ b/docs/images/logo.png
@@ -0,0 +1 @@
+../../public/icons/android-chrome-512x512.png \ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index e00a1d10..fb6f2cb8 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,7 +1,19 @@
# Welcome to the HedgeDoc Documentation
-This page should help you host and configure your own HedgeDoc instance.
+![HedgeDoc Logo](images/hedgedoc_logo_horizontal.png)
-We provide:
-- [Guides for common scenarios](guides/index.md)
-
+HedgeDoc lets you create real-time collaborative markdown notes. You can test-drive
+it by visiting our [HedgeDoc demo server][hedgedoc-demo].
+
+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](history.md) or [you can have a look at an explanitory graph over at our website][hedgedoc-history].
+
+If you have any questions that aren't answered here, feel free to ask us on [Matrix][matrix.org-url], stop by our [community forums][hedgedoc-community] or have a look at our [FAQ][hedgedoc-faq].
+
+
+[hedgedoc-demo]: https://demo.hedgedoc.org
+[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