| author | Olivier Brunel
<jjk@jjacky.com> 2023-01-16 18:53:01 UTC |
| committer | Olivier Brunel
<jjk@jjacky.com> 2023-01-16 18:53:01 UTC |
| parent | 1b82c69a801c0b027969297df322568f1c6fab91 |
| base.htm | +0 | -238 |
| base.md | +0 | -181 |
diff --git a/base.htm b/base.htm deleted file mode 100644 index d91dd33..0000000 --- a/base.htm +++ /dev/null @@ -1,238 +0,0 @@ -<!DOCTYPE html> -<html> - <head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"> - <meta charset="utf-8"> - <meta name="generator" content="qmdoc"> - <meta name="viewport" content="width=device-width, initial-scale=1.0"> - <meta name="theme-color" media="(prefers-color-scheme: light)" content="white"> - <meta name="theme-color" media="(prefers-color-scheme: dark)" content="gray"> - <title>Foobar Documentation</title> -<link rel="stylesheet" href="struct.css"> -<link rel="stylesheet" href="common.css"> -<link rel="stylesheet" href="light.css"> -<link rel="stylesheet" href="dark.css"> - </head> - <body> - <main> - <header> - <section> - <h1>Foobar Documentation</h1> - <h2>1.0.0</h2> - </section> - <nav> - <ul> - <li><a href="base.htm">Foobar Documentation</a> - <ul> - <li><a href="#welcome_to_foobar">Welcome to Foobar !</a> - <li><a href="#common_topics">Common Topics</a> - <ul> - <li><a href="#getting_started">Getting Started</a> - <li><a href="#this_is_level_2">This is level 2</a> - <ul> - <li><a href="#this_is_level_3">This is level 3</a> - <ul> - <li><a href="#this_is_level_4">This is level 4</a> - <ul> - <li><a href="#this_is_level_5">This is level 5</a> - <ul> - <li><a href="#this_is_level_6">This is level 6</a> - </ul> - </ul> - </ul> - </ul> - </ul> - <li><a href="#citations_needed">Citations Needed</a> - <ul> - <li><a href="#lists">Lists...</a> - </ul> - <li><a href="#highlights">Highlights</a> - <ul> - <li><a href="#code_blocks">Code Blocks</a> - </ul> - <li><a href="#links">Links</a></li> - <li><a href="#user_inputs">User Inputs</a> - <ul> - <li><a href="#keys">Keys</a> - <li><a href="#buttons">Buttons</a> - <li><a href="#mouse_buttons">Mouse buttons</a> - </ul> - <li><a href="#boxes">Boxes</a> - </ul> - </ul> - </nav> - </header> - <section> - <section id="welcome_to_foobar"> - <h1>Welcome to Foobar !</h1> - <p>This is the documentation for <strong>foobar</strong>. There will be - <em>much talk</em> about foo, bar, and <u>maybe</u> even baz. - </section> - <section> - <h1>Common Topics<span id="common_topics"><a - href="#common_topics"></a></span></h1> - <p>Here we discuss some <span class="highlight">common - topics</span> related to - <strong>foobar</strong> and its use. They vary, but <s>they all - matter</s>, so let's dive into to.</p> - <section id="getting_started"> - <h2>Getting Started</h2> - <p>Alright let's <span class="highlight2">get started</span> then.</p> - <p>We can test block stuff :</p> -<pre> -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. -</pre> - </section> - <section id="this_is_level_2"> - <h2>This is level 2</h2> - <p>Here is text in the level.</p> - <section id="this_is_level_3"> - <h3>This is level 3</h3> - <section id="this_is_level_4"> - <h4>This is level 4</h4> - <section id="this_is_level_5"> - <h5>This is level 5</h5> - <section id="this_is_level_6"> - <h6>This is level 6</h6> - <p>We have <sup>superscript</sup> as well as - <sub>subscript</sub> also. - </section> - </section> - </section> - </section> - </section> - </section> - <section id="citations_needed"> - <h1>Citations Needed</h1> - <p>Here's some <code>typetext stuff</code> after which will follow - no less than a quote : - <blockquote cite="https://source.lnk"><p>Here it is. I'm a - quote.<br>No really, I was said by someone, once.<br>I - swear.</p> - <cite>Someone. Once.</cite></blockquote> - Of course <q>everything has been said before</q> so, there. - <section id="lists"> - <h2>Lists...</h2> - <p>It is now time, to make it a list. Or two. Maybe - more.</p> - <p>First we'll have unordered ones :</p><ul> - <li>Item 1</li> - <li>Item 2<ul> - <li>Item 1b</li> - <li>Item 1b</li> - <li>Item 1c</li> - </ul></li> - <li>Item 3</li> - <li>Item 4</li> - </ul><p>And then ordered ones :<ol> - <li>First one<ol> - <li>One bis</li> - <li>One ter</li> - </ol></li> - <li>Second one</li> - <li>Third one</li> - </ol></p> - </section> - </section> - <section id="highlights"> - <h1>Highlights</h1> - <p>It might happen that you'd want to <strong> - <span class="highlight">highlight something</span></strong>. - Right, but <span class="highlight2">more</span> than that, or - more <em>literally</em> than that.</p> - <p>Anyays, here is the <span class="highlighted"><em>real</em> - highlighted effect</span>. And let's make it work in - <code>pre</code>/<code>code</code> blocks too (unlike the others) : -<pre> -This is a line. -It continues here, -but <span class="highlighted">watch out</span> for -the highlight. -Which, also, can <span class="highlighted">spawn -multiple lines</span>. Yep. -</pre></p> - <section id="code_blocks"> - <h2>Code Blocks</h2> - <p>Oh yeah, we might wanna have "code blocks". Those would - be like <code>pre</code> ones, only a bit more styled : -<pre class="lineno">1<br>2<br>3<br>4<br>5<br>6<br>7<br>8<br>9<br>10</pre> -<pre><span>c</span><code>#include <stdlib.h> -int main(int argc, char **argv) -{ - int nb = 3; - - for(int i = nb; i > 0; --i) - printf("%d... ", i<span class="highlighted">, nb</span>); - - printf("Hello World!\n"); -}</code></pre></p> - <p>Looking good? And yes, the <code>highlighted</code> effect - works in there too.</p> - </section> - </section> - <section id="links"> - <h1>Links</h1> - <p>Here what <a href="#">a link</a> might look - like.</p> - </section> - <section id="user_inputs"> - <h1>User Inputs</h1> - <p>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...</p> - <section id="keys"> - <h2>Keys</h2> - <p>You can use <kbd>Alt</kbd> + <kbd>C</kbd>, <kbd>Space</kbd> or - the famous <kbd>any</kbd> key.</p> - </section> - <section id="buttons"> - <h2>Buttons</h2> - <p>And for the sake of it, you can do the same with buttons. - Talking about the <span class="button">Save</span> button or - the like.</p> - </section> - <section id="mouse_buttons"> - <h2>Mouse buttons</h2> - <p>And to continue with this, let's have mouse buttons in case - you need to talk about <kbd>Ctrl</kbd> + - <span class="mbl"></span> or similar.</p> - </section> - </section> - <section id="boxes"> - <h1>Boxes</h1> - <p>A few boxes that can be useful from time to time :<br>First, - we have hints : - <div class="box hint"><span>Hint</span> - <p>Here goes a hint.</p></div> - Then basic informations : - <div class="box info"><span>Information</span> - <p>Here goes a warning.</p></div> - The usual warnings : - <div class="box warn"><span>Warning</span> - <p>Here goes a warning.</p></div> - And finally simple notes : - <div class="box note"><span>Note</span> - <p>This is a note.</p></div> - <p>Box inside a box:</p> - <div class="box note"><span>Note</span> - <p>This is a note.</p> - <div class="box hint"><span>Yep</span><p>That - works.</p></div> - </div> - </p> - </section> - <section id="navbuttons"> - <a class="prev" href="#" title="Previous Title">Previous</a> - <a class="next" href="#" title="Next Title">Next</a> - </section> - <footer> - Copyright © 2022 Author Name - All Rights Reserved - <br> - <span class="generated">Generated with qmdoc</span> - </footer> - </section> - </main> - </body> -</html> diff --git a/base.md b/base.md deleted file mode 100644 index e4571fb..0000000 --- a/base.md +++ /dev/null @@ -1,181 +0,0 @@ -% 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 : - -> 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. - -Well no, there's no =highlight= in there. It's not in basic ``pre`` blocks, that -is indented ones. But we can do it though, easy peasy : - -```pre hl -This is a line. -It continues here, -but <hl>watch out</hl> for -the =highlight=. -Which, also, can <hl>spawn -multiple lines</hl>. Yep. -``` - -And /voilà!/ - -## Code Blocks - -Oh yeah, we might wanna have "code blocks". Those would be like ``pre`` ones, -only a bit more styled : - -```c hl -#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: Confession -! Okay, this isn't anything from ``qmdoc`` really. -! That's just a /plain old HTML tag/, which we styled nicely. Still. - -## 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. - -Then basic informations : - -! INFO: -! Here goes some information. - -The usual warnings : - -! WARNING: -! Here goes a warning. - -And finally simple notes : - -! NOTE: -! This is a note. - -And a quote: - -> what? - -One can embed things. -! NOTE: Example -! For example, here's a quote: -! > This is a quote. -! -! ! Attention ! -! ! You can even put box into box.