Configuration

Le fichier de configuration est localisé dans votre projet/_markdocs/config.jsonc et peut être modifié avec n’importe quel éditeur de texte, il doit respecter le format JSON mais autorise les commentaires.

Détails

Nom de la propriété	Type de valeur	Valeur
`name`	Chaîne de caractères	Nom de la documentation, affiché dans le titre de la page.
`sidebarName`	Chaîne de caractères	Nom de la documentation, affiché dans la barre de navigation.
`githubLink`	Chaîne de caractères	Lien vers un dépôt GitHub, s’affichera dans la barre de navigation sur mobile. Définir une chaîne de caractères vide (`""`) pour masquer l’élément.
`twitterLink`	Chaîne de caractères	Lien vers un profil Twitter, s’affichera dans la barre de navigation sur mobile. Définir une chaîne de caractères vide (`""`) pour masquer l’élément.
`contactLink`	Chaîne de caractères	Lien vers une page de contact, s’affichera dans la barre de navigation sur mobile. Définir une chaîne de caractères vide (`""`) pour masquer l’élément.

Chemin du dossier des pièces jointes

Nom de la propriété	Type de valeur	Valeur
`attachmentsDir`	Chaîne de caractères	Chemin relatif à la racine du projet contenant les fichiers attachés à votre projet. Le chemin peut être absolu, mais + complexe à gérer lors d’un transfert par exemple ou pour utiliser Git. Sur Obsidian, il est possible de définir un dossier comme tel dans « Fichiers & Liens –> Chemin du dossier des pièces jointes ».

Organisation

Nom de la propriété	Type de valeur	Valeur
`pages`	Liste	Contenu de la sidebar principale. Contient le chemin de chaque document Markdown affiché dans la sidebar, l’ordre sera respecté lors de l’affichage. Pour afficher un séparateur, ajouter `---Nom d'une catégorie---`.
`folders`	Tableau	Gère le comportement des dossiers, ne doit pas être confondu avec les séparateurs dans la sidebar. Voir ci-dessous pour plus d’informations

`folders`

Permet de définir le chemin du dossier dans l’URL pour un dossier à partir de son emplacement

"Exemple": { // <-- nom du dossier (local)
    "slug": "example" // <-- chemin du dossier dans l'URL
},

Permet d’afficher différentes pages dans un dossier dans la sidebar

"Exemple/Sous-Dossier": { // <-- nom du dossier (local)
    "slug": "example/subfolder", // <-- chemin du dossier dans l'URL
    "pages": [ // Pages contenues dans le dossier, l'ordre sera respecté
        "Sous-Page.md"
    ]
}

Configuration

Détails

Chemin du dossier des pièces jointes

Organisation

folders

Sur cette page

`folders`