From 460ab8566d3c2a2b747491bafc79cae002345f4b Mon Sep 17 00:00:00 2001 From: Emmanuel Garette Date: Sun, 3 May 2026 17:59:04 +0200 Subject: [PATCH] [tutorial v1.1_000] Creating a structure file (config and doc) --- README.md | 52 +++++++++++++++++++++++++++++++++++++++- config/01/cmd_ro.txt | 1 + config/01/config.yml | 1 + config/01/output_ro.html | 1 + tree.html | 5 ++++ 5 files changed, 59 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 1dc2888b..c62a7ae2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,11 @@ +- [List of all the tutorial steps](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/branch/1.1/README.md) + +# [tutorial v1.1_000] Creating a structure file + +- [Read the tutorial "Creating a structure file" in the documentation](https://pedago.gwenaelremond.fr/bribes/rougail/tutorial/preliminary.html#creating-a-structure-file) +- [View the changes in the files](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_000~1..v1.1_000) + + ## Screenshot Firefox Proxy setting @@ -17,5 +25,47 @@ 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 +``` + +*** + + +- [[Next 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..24ce0202 --- /dev/null +++ b/config/01/output_ro.html @@ -0,0 +1 @@ +

diff --git a/tree.html b/tree.html
new file mode 100644
index 00000000..81f6c219
--- /dev/null
+++ b/tree.html
@@ -0,0 +1,5 @@
+

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

\ No newline at end of file