Informació respecte l'edició de la documentació
Introducció
Aquest lloc es genera de manera estàtica amb Eleventy.
Si pertanys al Grup XTEC de gitlab pots editar directament el projecte.
Els documents estan en format Markdown
Gitlab IDE
La manera més senzilla és editar els documents directament al Editor Web de Gitlab.
https://gitlab.com/-/ide/project/xtec/xtec.gitlab.io/edit/main/-/
Tota la documentació està al directori content:
Són fitxer markdown.
Entorn local
Quan estas editant la documentació pots arrencar un navegador perquè generi de manera dinàmica el lloc web.
TODO acabar d'explicar !
Windows
Instal.la VS Code.
Obre una consola de Powershell i executa npm run start mitjançant l'script node.ps1:
> .\node.ps1Linux
Per executar el projecte en un entorn local:
$ ./node.sh npm install
$ ./node.sh npm run start
...
[1] [11ty] Watching...
[1] [11ty] Server at http://localhost:8080/Búsqueda
TODO
Search
$ node.sh npx -y pagefind --site _site --serveShortcodes
Panel
Pots emmarcar contingut en un "panel" amb el "paired shortcode" panel tal com es mostra a continuació:
{% panel "Barcelona" %}
**Barcelona** és una ciutat i metròpoli a la costa mediterrània de la península Ibèrica.
{% endpanel %}
Barcelona
Barcelona és una ciutat i metròpoli a la costa mediterrània de la península Ibèrica.
Link
Per enllaçar una pàgina utilitzar el shortcut link:
{% link "/python/computation/" %} |
Computació | Path absolut |
{% link "p:/python/computation/" %}` |
Python - Computació | Si p: a l'inici, s'afageix el titol de la página pare |
{% link "./about/" %}` |
About | Si ./ a l'inici, enllaç relatiu respecte la pàgina pare |
{% link "p:./about/" %}` |
About | Si p:./ a l'inici, enllaç relatiu respecte la pàgina pare i s'afageix el titol de la página pare |
Solució
Per amagar la solució utiliza el "paired shortcode" sol tal com es mostra a continuació:
{% sol %}
```dockerfile
FROM alpine:latest
RUN apk update && apk add nmap
ENTRYPOINT ["nmap"]
CMD ["localhost"]
```
{% endsol %}
FROM alpine:latest
RUN apk update && apk add nmap
ENTRYPOINT ["nmap"]
CMD ["localhost"]Youtube
Per inserir un video de youtube:
{% youtube "ef0V67SorBE?si=V-5vrnMDM7GxgPdR" %}
Codi
Per marcar el codi..
En aquest enllaç tens tots els codis de llenguatges que pots utilitzar: Supported Languages
Per mostrar canvis en el codi afegeix el prefix diff al nom del llenguatge, i utilitza + o - al començament de cada linia per marcar que la linia s'ha afegit o s'ha eliminat.
+function myFunction() {
// …
- return true;
}