Skip to content
Snippets Groups Projects
Commit 80ad932a authored by alexandre.caldato's avatar alexandre.caldato
Browse files

modification markdown page

parent b5c0be44
No related branches found
No related tags found
1 merge request!3modification markdown page
...@@ -8,6 +8,33 @@ ...@@ -8,6 +8,33 @@
Pour expérimenter rapidement mkdocs avec le DSFR, vous pouvez cloner le [projet d'exemple](https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr-exemple). Pour expérimenter rapidement mkdocs avec le DSFR, vous pouvez cloner le [projet d'exemple](https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr-exemple).
## Configuration du dépôt et des liens d'édition
Dans le fichier `mkdocs.yml`, trois configurations importantes sont définies pour permettre aux utilisateurs de naviguer vers le dépôt source et d'éditer les pages directement :
* `repo_url`: URL du dépôt Git où le code source de la documentation est hébergé.
* `edit_uri`: Chemin relatif vers le dossier contenant les fichiers Markdown de la documentation dans le dépôt Git.
* `edit_text`: Texte à afficher pour le lien d'édition.
### Exemple de configuration
Dans ce projet, les configurations sont définies comme suit :
<pre><div class="bg-black rounded-md mb-4"><div class="flex items-center relative text-gray-200 bg-gray-800 px-4 py-2 text-xs font-sans justify-between rounded-t-md"><span>yaml</span><button class="flex ml-auto gap-2"><svg stroke="currentColor" fill="none" stroke-width="2" viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" class="h-4 w-4" height="1em" width="1em" xmlns="http://www.w3.org/2000/svg"><path d="M16 4h2a2 2 0 0 1 2 2v14a2 2 0 0 1-2 2H6a2 2 0 0 1-2-2V6a2 2 0 0 1 2-2h2"></path><rect x="8" y="2" width="8" height="4" rx="1" ry="1"></rect></svg>Copy code</button></div><div class="p-4 overflow-y-auto"><code class="!whitespace-pre hljs language-yaml">repo_url: https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr/
edit_uri: blob/main/docs/
edit_text: Éditer dans Gitlab Forge
</code></div></div></pre>
### Comment cela fonctionne
* `repo_url` pointe vers le dépôt GitLab où se trouve le code source de la documentation.
* `edit_uri` indique le chemin relatif vers les fichiers Markdown dans ce dépôt.
* `edit_text` spécifie le texte qui sera affiché pour le lien d'édition.
Si l'une de ces variables n'est pas remplie, le lien d'édition n'apparaîtra pas.
## Configuration du thème DSFR MkDocs ## Configuration du thème DSFR MkDocs
Ce document décrit les différentes options de configuration pour le thème DSFR MkDocs. Ce document décrit les différentes options de configuration pour le thème DSFR MkDocs.
......
...@@ -36,7 +36,6 @@ ...@@ -36,7 +36,6 @@
</title> </title>
{# {% block extrahead %}{% endblock %} #} {# {% block extrahead %}{% endblock %} #}
{# {%- block libs %} {# {%- block libs %}
<script src="{{ 'js/jquery-1.10.2.min.js'|url }}" defer></script>
<script src="{{ 'js/bootstrap.min.js'|url }}" defer></script> <script src="{{ 'js/bootstrap.min.js'|url }}" defer></script>
{%- endblock %} #} {%- endblock %} #}
</head> </head>
......
...@@ -230,3 +230,11 @@ th { ...@@ -230,3 +230,11 @@ th {
.revision-date { .revision-date {
text-align: center; text-align: center;
} }
@media (min-width: 62em) {
.fr-header .fr-nav {
display: flex;
align-items: center;
justify-content: space-between;
}
}
<nav class="fr-nav" id="navigation-547" role="navigation" aria-label="Menu principal"> <nav class="fr-nav navbar-header" id="navigation-547" role="navigation" aria-label="Menu principal">
<ul class="fr-nav__list"> <ul class="fr-nav__list">
{% for nav_item in nav %} {% for nav_item in nav %}
{% if not nav_item.children %} {% if not nav_item.children %}
...@@ -21,4 +21,11 @@ ...@@ -21,4 +21,11 @@
{% endif %} {% endif %}
{% endfor %} {% endfor %}
</ul> </ul>
{% if page.file and config.repo_url and config.edit_uri %}
<a href="{{ config.repo_url }}{{ config.edit_uri }}{{ page.file.src_path }}" target="_blank" rel="noopener">
{{ config.edit_text }}
</a>
{% endif %}
</nav> </nav>
...@@ -3,8 +3,9 @@ site_url: https://www.mkdocs.org/ ...@@ -3,8 +3,9 @@ site_url: https://www.mkdocs.org/
site_description: Project documentation with Markdown. site_description: Project documentation with Markdown.
site_author: MkDocs Team site_author: MkDocs Team
repo_url: https://github.com/mkdocs/mkdocs/ repo_url: https://gitlab-forge.din.developpement-durable.gouv.fr/pub/numeco/mkdocs-dsfr/
edit_uri: blob/master/docs/ edit_uri: blob/main/docs/
edit_text: Éditer dans Gitlab Forge
theme: theme:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment