rougail-tutorials/README.md

---
gitea: none
include_toc: true
---
# Summary


- [[tutorial 001] An empty file](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))
- [[tutorial 002] A first variable](https://forge.cloud.silique.fr/stove/rougail-tutorials/src/commit/v1.1_002/README.md) ([diff](https://forge.cloud.silique.fr/stove/rougail-tutorials/compare/v1.1_002~1..v1.1_002))


# Description


<img src="firefox.png" width=50% height=50% alt="Firefox Proxy setting"/>

A first variable

In the Firefox configuration, it is possible to define several configuration modes,
from no proxy at all ("No proxy") to a kind of automatic configuration mode from a file 
("Automatic proxy configuration URL").

We’re gonna create a first variable called "proxy_mode":

- accepts only a string as value
- requires a value (that is, None is not an option)

# Structure


## firefox/00-proxy.yml


```yml
---

```
## Generated documentation

```console
foo@bar:~$ rougail -v 1.1 -m firefox/ -o doc -do github
```