From 2d5f94a248d4530b372df4e91ce08f64ba435d04 Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sat, 22 Nov 2025 14:20:20 +0100 Subject: [PATCH] [tutorial v1.1_000)] Creating a structure file (config and doc) --- README.md | 54 +++++++++++++++++++++++++++++++++++++++- config/01/cmd_ro.txt | 1 + config/01/config.yml | 1 + config/01/output_ro.html | 5 ++++ tree.html | 44 ++++++++++++++++++++++++++++++++ 5 files changed, 104 insertions(+), 1 deletion(-) create mode 100644 config/01/cmd_ro.txt create mode 100644 config/01/config.yml create mode 100644 config/01/output_ro.html create mode 100644 tree.html diff --git a/README.md b/README.md index 60bbbf4f..1240c101 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +- [Summary](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) + +# [tutorial v1.1_000)] Creating a structure file + +[View the diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000) + +[Read the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) + + ## Screenshot @@ -21,5 +30,48 @@ pip install rougail-cli rougail-output-exporter rougail-output-doc rougail-user- Then switch to the tutorial page: ```shell -git switch --detach 1.1 +git switch --detach v1.1_000 ``` + +## Structure + + + +

+.
+ └── firefox
+     └── 00-proxy.yml
+

+ +Contents of the firefox/00-proxy.yml file + +```yml +%YAML 1.2 +--- +version: 1.1 +... + +``` +## User datas + +### Example 1 + +#### config/01/config.yml + + +```yml +--- +``` +#### Output + +```shell +rougail -m firefox/ -u yaml -yf config/01/config.yml +``` +
╭─ Caption ─╮
+│           │
+╰───────────╯
+Variables:
+
+ + +- [[tutorial v1.1_001] Let’s add our first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_001/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_001~1..v1.1_001)) diff --git a/config/01/cmd_ro.txt b/config/01/cmd_ro.txt new file mode 100644 index 00000000..d46f9445 --- /dev/null +++ b/config/01/cmd_ro.txt @@ -0,0 +1 @@ +rougail -m firefox/ -u yaml -yf config/01/config.yml \ No newline at end of file diff --git a/config/01/config.yml b/config/01/config.yml new file mode 100644 index 00000000..ed97d539 --- /dev/null +++ b/config/01/config.yml @@ -0,0 +1 @@ +--- diff --git a/config/01/output_ro.html b/config/01/output_ro.html new file mode 100644 index 00000000..b3c7713f --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1,5 @@ +
╭─ Caption ─╮
+│           │
+╰───────────╯
+Variables:
+
diff --git a/tree.html b/tree.html new file mode 100644 index 00000000..5ca2bf3e --- /dev/null +++ b/tree.html @@ -0,0 +1,44 @@ + + + + + + + Directory Tree + + + +

Directory Tree

+ .
+ └── firefox
+     └── 00-proxy.yml
+

+ +2 directories, 1 file + +

+
+

+ tree v2.2.1 © 1996 - 2024 by Steve Baker and Thomas Moore
+ HTML output hacked and copyleft © 1998 by Francesc Rocher
+ JSON output hacked and copyleft © 2014 by Florian Sesser
+ Charsets / OS/2 support © 2001 by Kyosuke Tokoro +

+ +