From 565f52b72b5a0962cffd63a0e1aa1002d8bd3b6a Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Wed, 20 Feb 2019 00:01:01 +0100 Subject: [PATCH 1/2] Update README.md --- README.md | 114 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 113 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e17852f..4f948cb 100644 --- a/README.md +++ b/README.md @@ -1 +1,113 @@ -## WidgetBot documentation +[assets]: https://github.com/widgetbot-io/documentation/tree/master/docs/assets +[embed]: https://github.com/widgetbot-io/documentation/tree/master/docs/embed +[guides]: https://github.com/widgetbot-io/documentation/tree/master/docs/guides +[self-hosted]: https://github.com/widgetbot-io/documentation/tree/master/docs/self-hosted] +[tutorial]: https://github.com/widgetbot-io/documentation/tree/master/docs/tutorial +[crate]: https://github.com/widgetbot-io/documentation/tree/master/docs/embed/crate +[html-embed]: https://github.com/widgetbot-io/documentation/tree/master/docs/embed/html-embed +[react-embed]: https://github.com/widgetbot-io/documentation/tree/master/docs/embed/react-embed + +# WidgetBot documentation +This repository contains the documentation, that can be found at https://docs.widgetbot.io/ +Any contributions and improvements of the documentation are welcome. + +# Content + +## [assets] +Contains files like images and general css/js stuff for defining the style of the site. +Please don't touch those. + +## [embed] +Contains documentation about the [crate], the [html-embed] and the [react-embed]. + +## [guides] +General guides about fixing issues (currently how to switch to a cluster). + +## [self-hosted] +Information about how to self-host the WidgetBot. + +## [tutorial] +Tutorials. + +# Styling +The used sites are saved as markdown-files (`.md`) and use markdown and some basic html, like iframes. +But there is also some own additional styling used in order to provide additional stuff. + +## Boxes +The documentation can have boxes containing infos, tips or similar. +Each type of box follows a similar pattern. + +You start with three exclamation marks (`!`) followed by the type (info, tip, note, example, question, warning or success) and the title of the box. +The title needs to be in `"` (Example: `!!! info "Hello there"`) +The actual content of the box needs to be on a seperate line and start with 4 spaces. + +### Info +``` +!!! info "Note" + This section is for self-hosting the WidgetBot **server**, not the embed or other things. Only Legendary [patrons](https://widgetbot.io/patron) can self-host the server. +``` + +**Result**: +![](https://i.imgur.com/MCLHVly.png) + +---- +### tip +``` +!!! tip "Important" + WidgetBot will not work if you don't add a cluster bot to your server! +``` + +**Result**: +![](https://i.imgur.com/j8cmLrw.png) + +---- +### note +``` +!!! note + There is no difference between the clusters. +``` + +**Result**: +![](https://i.imgur.com/eTY0aSc.png) + +---- +### example +``` +!!! example "iframe example with cluster" + ```html + + ``` +``` + +**Result**: +![](https://i.imgur.com/lK2SfSL.png) + +---- +### question +``` +!!! question "Need help?" + If you need any assistance adding WidgetBot, please ask in [the server](https://discord.gg/NYBEhN7). **However**, please make sure you mention **what the issue is**, **send your code** in a codeblock (` ``` `), include **your server id and cluster**, and optionally include **a link to your site**. +``` + +**Result**: +![](https://i.imgur.com/l8q0MCz.png) + +---- +### warning +``` +!!! warning "Important" + **This tutorial assumes you have already completed the [Getting Started with WidgetBot](/tutorial) tutorial.** If you have not, please read it and **invite a cluster bot**. +``` + +**Result**: +![](https://i.imgur.com/nyMTMDD.png) + +---- +### success +``` +!!! success "Complete!" + You have successfully set up WidgetBot. +``` + +**Result**: +![](https://i.imgur.com/J0Xa7tf.png) From 3a0debfe128aa82cdc941816107b7bd8cd41083d Mon Sep 17 00:00:00 2001 From: Andre_601 <11576465+Andre601@users.noreply.github.com> Date: Wed, 20 Feb 2019 16:51:29 +0100 Subject: [PATCH 2/2] Replace ## Boxes with ## Links --- README.md | 88 +++++++------------------------------------------------ 1 file changed, 10 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 4f948cb..bb94e01 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ [crate]: https://github.com/widgetbot-io/documentation/tree/master/docs/embed/crate [html-embed]: https://github.com/widgetbot-io/documentation/tree/master/docs/embed/html-embed [react-embed]: https://github.com/widgetbot-io/documentation/tree/master/docs/embed/react-embed +[Support]: https://discord.gg/8zYvp6W +[Invite the Bot]: https://add.widgetbot.io/cl2 +[Admonition]: https://squidfunk.github.io/mkdocs-material/extensions/admonition +[GitHub]: https://github.com/widgetbot-io/widgetbot # WidgetBot documentation This repository contains the documentation, that can be found at https://docs.widgetbot.io/ @@ -33,81 +37,9 @@ Tutorials. The used sites are saved as markdown-files (`.md`) and use markdown and some basic html, like iframes. But there is also some own additional styling used in order to provide additional stuff. -## Boxes -The documentation can have boxes containing infos, tips or similar. -Each type of box follows a similar pattern. - -You start with three exclamation marks (`!`) followed by the type (info, tip, note, example, question, warning or success) and the title of the box. -The title needs to be in `"` (Example: `!!! info "Hello there"`) -The actual content of the box needs to be on a seperate line and start with 4 spaces. - -### Info -``` -!!! info "Note" - This section is for self-hosting the WidgetBot **server**, not the embed or other things. Only Legendary [patrons](https://widgetbot.io/patron) can self-host the server. -``` - -**Result**: -![](https://i.imgur.com/MCLHVly.png) - ----- -### tip -``` -!!! tip "Important" - WidgetBot will not work if you don't add a cluster bot to your server! -``` - -**Result**: -![](https://i.imgur.com/j8cmLrw.png) - ----- -### note -``` -!!! note - There is no difference between the clusters. -``` - -**Result**: -![](https://i.imgur.com/eTY0aSc.png) - ----- -### example -``` -!!! example "iframe example with cluster" - ```html - - ``` -``` - -**Result**: -![](https://i.imgur.com/lK2SfSL.png) - ----- -### question -``` -!!! question "Need help?" - If you need any assistance adding WidgetBot, please ask in [the server](https://discord.gg/NYBEhN7). **However**, please make sure you mention **what the issue is**, **send your code** in a codeblock (` ``` `), include **your server id and cluster**, and optionally include **a link to your site**. -``` - -**Result**: -![](https://i.imgur.com/l8q0MCz.png) - ----- -### warning -``` -!!! warning "Important" - **This tutorial assumes you have already completed the [Getting Started with WidgetBot](/tutorial) tutorial.** If you have not, please read it and **invite a cluster bot**. -``` - -**Result**: -![](https://i.imgur.com/nyMTMDD.png) - ----- -### success -``` -!!! success "Complete!" - You have successfully set up WidgetBot. -``` - -**Result**: -![](https://i.imgur.com/J0Xa7tf.png) +## Links +Here are some links, that might be useful for you. +* [Support] - Need help? Join the WidgetBot-guild to get support with the bot. +* [Invite the Bot] - Use this link to invite the Bot (Cluster 2) to your Guild! +* [Admonition] - A extension of the mkdocs-material library that is used for things like Info-boxes. +* [GitHub] - WidgetBot is open source. Check it out.