Ce bloc-notes mdBook vous est proposé avec passion par Marc JESTIN — Happy Numeric.
À votre service pour vous accompagner dans vos projets numériques.
Contact : https://happynumeric.fr/me-contacter.
mdBook : liens internes : Chemins relatifs
Nous devons utiliser des liens internes avec des chemins relatifs pour écrire des liens vers des ressources du projet mdBook en cours.
L'utilisation de liens internes facilite la portabilité du projet : changement de nom de domaine ou de l'emplacement du projet en ligne.
Nous pouvons écrire un lien interne vers :
- un fichier image ;
- un
fichiers.md
en tant que liens Web ouvrant la page correspondante ; - un chapitre de page mdBook en tant que lien Web ouvrant la page correspondante en affichant et surlignant le chapitre de page ;
- un
fichier.md
à insérer ; - un
fichier-de-code
à insérer, qui peut être unfichiers.rs
(écrit en langage Rust).
Les liens des chapitres du sommaire mdBook utilisent les mêmes règles que les liens internes des pages mdBook.
Syntaxe des liens internes
Pour écrire un lien vers un contenu du même projet mdBook, nous utilisons un lien interne qui s'écrit comme suit.
Choix des liens Web pour illustrer
Je prends ici l'exemple de l'écriture d'un lien Web ([texte](lien-interne)
).
Les principes décrits ici pour l'écriture d'un lien interne pour un lien Web s'appliquent dans les autres cas d'écriture de liens.
Tous les liens Web que nous voyons ci-après sous écrits sous la forme : [Texte](lien)
qui s'affiche : Texte` et qui crée un lien Web vers le contenu souhaité.
Lien Web vers une autre page mdBook dans le même dossier
Pour écrire un lien interne vers un fichier.md
dans le même dossier, nous écrivons : [Texte](fichier.md)
.
Lien Web vers un fichier.md
dans un sous-dossier
Dans le cas où le fichier.md
destination est dans un sous-dossier dossier
, nous écrivons [Texte](dossier/fichier.md)
.
Lien depuis un fichier dans un sous-dossier
Nous avons cette structure de dossiers et fichiers :
|
-----> src (dossier)
fichier.md
|--------> dossier-1 (dossier)
fichier-du-dossier-1.md
|--------> dossier-2 (dossier)
fichier-du-dossier-2.md
Nous écrivons un lien interne vers fichier.md
dans fichier-du-dossier-1.md
sous cette forme : [Texte](../fichier.md)
.
Pour écrire un lien vers fichier-du-dossier-2.md
dans fichier-du-dossier-1.md
, nous écrivons [Texte du lien](../dossier-2/fichier-du-dossier-2.md)
.
Avec ou sans le ./
Lorsque nous écrivons un lien interne vers un fichier, nous pouvons utiliser le format avec un ./
du dossier en cours, sous la forme [Texte](./dossier/fichier.md)
mais ce n'est pas la forme proposée par la documentation officielle mdBook.
Lien vers le site Web mdBook en cours
Si nous éditons un fichier.md
dans le dossier source, le lien interne vers le site Web mdBook en cours d'édition est [Texte](./)
.
Lien depuis un sous-dossier
Si nous avons cette structure de dossiers et de fichiers :
|
-----> src (dossier)
|--------> dossier (dossier)
fichier.md
Le lien vers le site Web mdBook depuis fichier.md
est [Texte](../)
.
Lien Web vers un chapitre de page mdBook
Voir : mdBook : Liens internes : Chapitres de pages mdBook.
Le lien (./) ne fonctionne pas en accès direct aux fichiers
En principe, nous n'accédons pas à notre site en cours de création par accès direct aux fichiers, nous utilisons
mdbook serve
dont je parle dans mdBook serve : Visualiser nos modifications en continu.
Si nous consultons le site Web mdBook que nous sommes en train d'éditer par accès direct aux fichiers sur notre machine, les liens internes de type (./)
nous renvoient vers l'affichage du dossier local nom-du-projet/book
(par défaut), par exemple dans mon cas pour ce projet :
Utilisation de liens Web de sous la forme <https://>
Il est possible d'utiliser cette syntaxe pour afficher un lien vers une page mdBook d'un même projet mdBook :
<https://site-du-projet-mdBook/dossier/fichier.html>
pour afficher un lien vers une page mdBook ;<https://site-du-projet-mdBook/dossier/fichier.html#chapitre-de-page-mdbook>
pour afficher un lien vers un chapitre de page mdBook.
Nous réservons cette syntaxe à des cas particuliers comme cette astuce : mdBook : Surligner toutes les occurences d'un mot dans une page mdBook.
Nous pouvons choisir d'utiliser cette syntaxe pour rendre l'adresse URL explicite sur le site sans avoir besoin d'écrire [https://site-du-projet-mdBook/dossier/fichier.html](https://site-du-projet-mdBook/dossier/fichier.html)
mais cela ne me semble pas pertinent du tout.
Ce bloc-notes mdBook vous est proposé par Marc JESTIN — Happy Numeric. |
Formation, rédaction de documentations techniques ou organisationnelles, mise en place de solutions documentaires internes et externes, assistance à maîtrise d'ouvrage, etc. |
Contact : https://happynumeric.fr/me-contacter |
N'hésitez pas à me faire votre feedback, me signaler des erreurs ou des compléments que vous souhaiteriez que j'ajoute à ce bloc-notes mdBook.
Cliquez ici pour me contacter
À propos de cette page
Création : 17 mars 2023
Dernière mise à jour : 23 mars 2023 23:42