Generate HTML documentation using MkDocs (WIP)

[github/shaarli/Shaarli.git] / doc / md / index.md

diff --git a/doc/md/index.md b/doc/md/index.md
new file mode 100644 (file)
index 0000000..37a9c1f
--- /dev/null
+++ b/doc/md/index.md
@@ -0,0 +1,11 @@
+Welcome to the [Shaarli](https://github.com/shaarli/Shaarli/) wiki!
+
+Here you can find some info on how to use, configure, tweak and solve problems with your Shaarli.
+
+For general info, read the [README](https://github.com/shaarli/Shaarli/blob/master/README.md).
+
+If you have any questions or ideas, please join the [chat](https://gitter.im/shaarli/Shaarli) (also reachable via [IRC](https://irc.gitter.im/)), post them in our [general discussion](https://github.com/shaarli/Shaarli/issues/308) ([archive](https://github.com/shaarli/Shaarli/issues/44)) or read the current [issues](https://github.com/shaarli/Shaarli/issues). If you've found a bug, please create a [new issue](https://github.com/shaarli/Shaarli/issues/new).
+
+If you would like a feature added to Shaarli, check the issues labeled [`feature`](https://github.com/shaarli/Shaarli/labels/feature), [`enhancement`](https://github.com/shaarli/Shaarli/labels/enhancement), and [`plugin`](https://github.com/shaarli/Shaarli/labels/plugin).
+
+_Note: This documentation is available online at https://github.com/shaarli/Shaarli/wiki, and locally in the `doc/` directory of your Shaarli installation._