author | Olivier Brunel
<jjk@jjacky.com> 2022-12-24 14:44:23 UTC |
committer | Olivier Brunel
<jjk@jjacky.com> 2022-12-24 14:44:23 UTC |
parent | 239ba7bfc96151bfe8316ead203e7d58fdfd4a33 |
base.md | +148 | -0 |
diff --git a/base.md b/base.md new file mode 100644 index 0000000..c1cff78 --- /dev/null +++ b/base.md @@ -0,0 +1,148 @@ +:Foobar Documentation + +# Welcome to Foobar ! + +This is the documentation for *foobar*. There will be /much talk/ about foo, +bar, and _maybe_ even baz. + +# Common Topics + +Here we discuss some #common topics# related to *foobar* and its use. They vary, +but ~they all matter~, so let's dive into it. + +## Getting Started + +Alright let's ##get started## then. + +We can test block stuff : + + This is a text. + No formatting or anything there. + Now we will have to test some very long line, to see how the overflow is handled and make sure it works as expected. That is, as we expect, i.e. things don't break and a nice little scrollbar is featured. + +## This is level 2 + +Here is text in the level. + +### This is level 3 + +#### This is level 4 + +##### This is level 5 + +###### This is level 6 + +We have ^^superscript^^ as well as ,,subscript,, also. + +# Citations Needed + +Here's some ``typetext stuff`` after which will follow no less than a quote : + +>!https://source.lnk +> Here it is. I'm a quote. \ +> No really, I was said by someone, once. \ +> I swear. +>:Someone. Once. + +Of course <q>everything has been said before</q> so, there. + +## Lists... + +It is now time, to make it a list. Or two. Maybe more. + +First we'll have unordered ones : + +* Item 1 +* Item 2 + * Item 1b + * Item 1b + * Item 1c +* Item 3 +* Item 4 + +And then ordered ones : + +1. First one + 1. One bis + 2. One ter +2. Second one +3. Third one + +# Highlights + +It might happen that you'd want to *#highlight something#*. Right, but ##more## +than that, or more /literally/ than that. + +Anyways, here is the <hl>/real/ highlighted effect</hl>. And let's make it work +in ``pre``/``code`` blocks too (unlike the others) : + + This is a line. + It continues here, + but <hl>watch out</hl> for + the highlight. + Which, also, can <hl>spawn + multiple lines</hl>. Yep. + +## Code Blocks + +Oh yeah, we might wanna have "code blocks". Those would be like ``pre`` ones, +only a bit more styled : + +``` +#include <stdlib.h> +int main(int argc, char **argv) +{ + int nb = 3; + + for(int i = nb; i > 0; --i) + printf("%d... ", i<hl>, nb</hl>); + + printf("Hello World!\n"); +} +``` + +Looking good? And yes, the ``highlighted`` effect works in there too. + +# Links + +Here's what [a link](#) might look like. + +# User Inputs + +Because in documentation you might wanna talk about user interactions with the +application, and that might not always be a command-line interface that's talked +about. So... + +## Keys + +You can use <kbd>Alt</kbd> + <kbd>C</kbd>, <kbd>Space</kbd> or the famous +<kbd>any</kbd> key. + +<info title="Confession">Okay, this isn't anything from ``qmdoc`` really. +That's just a plain old HTML tag, which we styled nicely. Still.</info> + +## Buttons + +And for the sake of it, you can do the same with buttons. Talking about the +<btn>Save</btn> button or the like. + +## Mouse buttons + +And to continue with this, let's have mouse buttons in case you need to talk +about <kbd>Ctrl</kbd> + <mbl> or similar. + +# Boxes + +A few boxes that can be useful from time to time : \ +First, we have hints : +<hint>Here goes a hint.</hint> + +Then basic informations : +<info>Here goes some information.</info> + +The usual warnings : +<warn>Here goes a warning.</warn> + +And finally simple notes : +<note>This is a note.</note> +