3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-10 23:57:22 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/docs/fr/doc-markdown.html
Website Deployment Script 53d2a111cd Deploy website 
Deploy website version based on 956d701cf5
2020-04-22 06:46:52 +00:00

272 lines
No EOL
38 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="fr"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Markdown Features · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Docusaurus utilise [GitHub Flavored Markdown (GFM)](https://guides.github.com/features/mastering-markdown/). En savoir plus sur les champs spécifiques de Docusaurus lors de l&#x27;écriture de Markdown."/><meta name="docsearch:version" content="1.14.4"/><meta name="docsearch:language" content="fr"/><meta property="og:title" content="Markdown Features · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="Docusaurus utilise [GitHub Flavored Markdown (GFM)](https://guides.github.com/features/mastering-markdown/). En savoir plus sur les champs spécifiques de Docusaurus lors de l&#x27;écriture de Markdown."/><meta property="og:image" content="https://docusaurus.io/img/docusaurus.png"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://docusaurus.io/img/docusaurus.png"/><link rel="shortcut icon" href="/img/docusaurus.ico"/><link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://docusaurus.io/blog/atom.xml" title="Docusaurus Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://docusaurus.io/blog/feed.xml" title="Docusaurus Blog RSS Feed"/><script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-44373548-31', 'auto');
ga('send', 'pageview');
</script><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/code-blocks-buttons.js"></script><script src="https://unpkg.com/vanilla-back-to-top@7.1.14/dist/vanilla-back-to-top.min.js"></script><script>
document.addEventListener('DOMContentLoaded', function() {
addBackToTop(
{"zIndex":100}
)
});
</script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/prism.css"/><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/fr"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/fr/versions"><h3>1.14.4</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/fr/installation" target="_self">Documentations</a></li><li class=""><a href="/docs/fr/tutorial-setup" target="_self">Tutoriel</a></li><li class=""><a href="/fr/users" target="_self">Utilisateurs</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_self">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>Français</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/doc-markdown">English</a></li><li><a href="/docs/ko/doc-markdown">한국어</a></li><li><a href="/docs/pt-BR/doc-markdown">Português (Brasil)</a></li><li><a href="/docs/ro/doc-markdown">Română</a></li><li><a href="/docs/ru/doc-markdown">Русский</a></li><li><a href="/docs/zh-CN/doc-markdown">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Aidez-nous à traduire</a></li></ul></div></li><script>
const languagesMenuItem = document.getElementById("languages-menu");
const languagesDropDown = document.getElementById("languages-dropdown");
languagesMenuItem.addEventListener("click", function(event) {
event.preventDefault();
if (languagesDropDown.className == "hide") {
languagesDropDown.className = "visible";
} else {
languagesDropDown.className = "hide";
}
});
</script></span><li class="navSearchWrapper reactNavSearchWrapper"><input type="text" id="search_input_react" placeholder="Search" title="Search"/></li></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>API</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Premiers pas<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/fr/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/site-preparation">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/site-creation">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/publishing">Publishing your site</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/docker">Docker</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Guides<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/fr/adding-blog">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/custom-pages">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/search">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/navigation">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/translation">Translations &amp; Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/versioning">Versioning</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">API<span class="arrow"><svg width="24" height="24" viewBox="0 0 24 24"><path fill="#565656" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path><path d="M0 0h24v24H0z" fill="none"></path></svg></span></h3><ul class="hide"><li class="navListItem"><a class="navItem" href="/docs/fr/commands">CLI Commands</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/fr/doc-markdown">Markdown Features</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/api-pages">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/site-config">siteConfig.js</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</script></nav></div><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://crowdin.com/project/docusaurus/fr" target="_blank" rel="noreferrer noopener">Translate</a><h1 id="__docusaurus" class="postHeaderTitle">Markdown Features</h1></header><article><div><span><p>Docusaurus utilise <a href="https://guides.github.com/features/mastering-markdown/">GitHub Flavored Markdown (GFM)</a>. En savoir plus sur les champs spécifiques de Docusaurus lors de l'écriture de Markdown.</p>
<h2><a class="anchor" aria-hidden="true" id="entêtes-de-markdown"></a><a href="#entêtes-de-markdown" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Entêtes de Markdown</h2>
<h3><a class="anchor" aria-hidden="true" id="documents"></a><a href="#documents" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Documents</h3>
<p>Les documents utilisent les champs d'entête markdown suivants qui sont entourés par une ligne <code>---</code> de chaque côté :</p>
<ul>
<li><code>id</code>: Un identifiant unique de document. Si ce champ n'est pas présent, le fichier <code>id</code> du document prendra par défaut son nom de fichier (sans l'extension).</li>
<li><code>title</code>: Le titre de votre document. Si ce champ n'est pas présent, le <code>title</code> du document sera par défaut celui de son <code>id</code>.</li>
<li><code>hide_title</code> : Si vous voulez cacher le titre en haut de la doc.</li>
<li><code>description</code> : La description de votre document qui sera fournit dans <code>&lt;meta name=&quot;description&quot; content=&quot;...&quot;/&gt;</code> et <code>&lt;meta property=&quot;og:description&quot; content=&quot;...&quot;/&gt;</code> du <code>&lt;head&gt;</code>, utilisé par les moteurs de recherche. Si ce champ n'est pas présent, il sera par défaut à la première ligne du contenu.</li>
<li><code>sidebar_label</code> : Le texte affiché dans la barre latérale du document et dans le bouton suivant/précédent pour ce document. Si ce champ n'est pas présent, le <code>sidebar_label</code> du document sera par défaut celui de son <code>title</code>.</li>
</ul>
<p>Par exemple :</p>
<pre><code class="hljs css language-yaml"><span class="hljs-meta">---</span>
<span class="hljs-attr">id :</span> <span class="hljs-string">doc1</span>
<span class="hljs-attr">titre :</span> <span class="hljs-string">Mon</span> <span class="hljs-string">Document</span>
<span class="hljs-attr">sidebar_label :</span> <span class="hljs-string">Document</span>
<span class="hljs-meta">---</span>
</code></pre>
<p>Les documents versionnés ont leurs identifiants modifiés pour inclure le numéro de version lorsqu'ils sont copiés. Le nouvel <code>id</code> est <code>version-${version}-${id}</code> où <code>${version}</code> est le numéro de version de ce document et <code>${id}</code> est l'original <code>id</code>. De plus, les documents versionnés obtiennent un champ <code>original_id</code> supplémentaire avec l'identifiant du document original.</p>
<p>Par exemple :</p>
<pre><code class="hljs css language-yaml"><span class="hljs-meta">---</span>
<span class="hljs-attr">id:</span> <span class="hljs-string">version-1.0.0-doc1</span>
<span class="hljs-attr">title:</span> <span class="hljs-string">Mon</span> <span class="hljs-string">Document</span>
<span class="hljs-attr">sidebar_label:</span> <span class="hljs-string">Document</span>
<span class="hljs-attr">original_id:</span> <span class="hljs-string">doc1</span>
<span class="hljs-meta">---</span>
</code></pre>
<p><code>custom_edit_url</code>: L'url pour éditer le document. Si ce champ n'est pas présent, l'url du document va retournera <code>editUrl</code> depuis les champs optionnel de <code>siteConfig.js</code>. Consulter les docs de <a href="/docs/fr/site-config">siteConfig.js</a> pour plus d'informations.</p>
<p>Par exemple :</p>
<pre><code class="hljs css language-yaml"><span class="hljs-meta">---</span>
<span class="hljs-attr">id:</span> <span class="hljs-string">doc-markdown</span>
<span class="hljs-attr">title:</span> <span class="hljs-string">Fonctionnalités</span> <span class="hljs-string">de</span> <span class="hljs-string">Markdown</span>
<span class="hljs-attr">custom_edit_url:</span> <span class="hljs-string">https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md</span>
<span class="hljs-meta">---</span>
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="publications-de-blog"></a><a href="#publications-de-blog" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Publications de blog</h3>
<p>Les articles du blog suivent les entêtes de markdown qui sont encadrées par une ligne <code>---</code> de chaque coté:</p>
<p><code>titre</code>: Le titre de cet article du blog.</p>
<p><code>author</code> : L'auteur de cet article du blog. Si ce champ est omis, aucun nom d'auteur ne sera affiché.</p>
<p><code>authorURL</code> : Une page vers laquelle se connecter lorsqu'un utilisateur du site clique sur le nom de l'auteur. Si ce champ est omis, le nom de l'auteur ne sera lié à rien.</p>
<p><code>authorFBID</code> : L'identifiant Facebook de l'auteur, utilisé uniquement pour obtenir la photo de profil de l'auteur à afficher avec l'article du blog. Si ce champ est omis, aucune image d’auteur ne sera affichée pour l'article du blog.</p>
<p>Par exemple :</p>
<pre><code class="hljs css language-yaml"><span class="hljs-meta">---</span>
<span class="hljs-attr">title:</span> <span class="hljs-string">Mon</span> <span class="hljs-string">premier</span> <span class="hljs-string">post</span>
<span class="hljs-attr">author:</span> <span class="hljs-string">Frank</span> <span class="hljs-string">Li</span>
<span class="hljs-attr">authorURL:</span> <span class="hljs-string">http://twitter.com/franchementli</span>
<span class="hljs-attr">authorFBID:</span> <span class="hljs-number">100002976521003</span>
<span class="hljs-meta">---</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="fonctionnalités-supplémentaires"></a><a href="#fonctionnalités-supplémentaires" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Fonctionnalités supplémentaires</h2>
<p>Docusaurus prend en charge certaines fonctionnalités supplémentaires lors de l'écriture de la documentation en markdown.</p>
<h3><a class="anchor" aria-hidden="true" id="lier-dautres-documents"></a><a href="#lier-dautres-documents" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Lier d'autres documents</h3>
<p>Vous pouvez utiliser des url relatives à d'autre fichiers de documentation qui seront automatiquement convertit en des liés correspondant quand ils seront rendus.</p>
<p>Exemple :</p>
<pre><code class="hljs css language-md">[<span class="hljs-string">Ce lien vers un autre document</span>](<span class="hljs-link">other-document.md</span>)
</code></pre>
<p>Ce markdown sera automatiquement converti en un lien vers <code>/docs/other-document.html</code> (ou le lien correctement traduit/versionné) une fois qu'il sera affiché.</p>
<p>Ceci peut vous aider quand vous voudrez naviguer dans la documentation sur GitHub puisque les liens seront des liens fonctionnels vers d'autres document (toujours sur GitHub), mais les documents auront des liens HTML corrects lorsqu'ils seront rendus.</p>
<h3><a class="anchor" aria-hidden="true" id="lien-vers-les-images-et-autres-ressources"></a><a href="#lien-vers-les-images-et-autres-ressources" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Lien vers les images et autres ressources</h3>
<p>Des assets statiques peuvent être inclus de la même façon que le sont les documents, en utilisant des liens relatifs. Les ressources statiques utilisées dans les documents et les blogs doivent aller respectivement dans <code>docs/assets</code> et <code>website/blog/assets</code>. Le markdown sera converti avec des chemins de liens corrects afin que ces chemins fonctionnent pour les documents de toutes les langues et versions.</p>
<p>Exemple :</p>
<pre><code class="hljs css language-md">![<span class="hljs-string">alt-text</span>](<span class="hljs-link">assets/doc-image.png</span>)
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="génération-dune-table-des-matières"></a><a href="#génération-dune-table-des-matières" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Génération d'une table des matières</h3>
<p>Vous pouvez créer une liste auto-générée de liens, qui seront utiles pour une table des matières pour la documentation de l'API.</p>
<p>Dans votre fichier Markdown, insérez une ligne avec le texte <code>&lt;AUTOGENERATED_TABLE_OF_CONTENTS&gt;</code>. Écrivez votre documentation en utilisant les entêtes <code>h3</code> pour chaque fonction à l'intérieur d'un bloc de code. Celles-ci seront trouvées par Docusaurus et une liste de liens vers ces sections sera insérée dans le texte ``.</p>
<p>Exemple :</p>
<pre><code class="hljs css language-md"><span class="hljs-section">### `docusaurus.function(a, b)`</span>
Texte décrivant ma fonction
<span class="hljs-section">### `docdoc(file)`</span>
Texte décrivant ma fonction
</code></pre>
<p>ceci donnera une table des matières des fonctions :</p>
<pre><code class="hljs css language-md"><span class="hljs-bullet">- </span><span class="hljs-code">`docusaurus.function(a, b)`</span>
<span class="hljs-bullet">- </span><span class="hljs-code">`docdoc(file)`</span>
</code></pre>
<p>et chaque fonction sera liée à leurs sections correspondantes dans la page.</p>
<h3><a class="anchor" aria-hidden="true" id="onglets-de-code-spécifiques-au-langage"></a><a href="#onglets-de-code-spécifiques-au-langage" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Onglets de code spécifiques au langage</h3>
<p>Affiche le code dans plusieurs langages de programmation en utilisant des onglets de code. Tout d'abord, marquez le début et la fin d'un groupe d'onglets de code, en utilisant respectivement <code>&lt;!-- DOCUSAURUS_CODE_TABS --&gt;</code> et <code>&lt;! - END_DOCUSAURUS_CODE_TABS --&gt;</code> dans votre markdown. Ensuite, démarrez chaque onglet avec <code>&lt;!--[TAB_TITLE]--&gt;</code>.</p>
<p>En ajoutant le code suivant à votre fichier Markdown :</p>
<script src="https://gist.github.com/yangshun/d36d04f383c40beb3f31dd2a16666f6c.js"></script>
<p>cela produira :<!--DOCUSAURUS_CODE_TABS-->```js
console.log('Hello, world!');</p>
<pre><code class="hljs">
```py
<span class="hljs-function"><span class="hljs-title">print</span><span class="hljs-params">(<span class="hljs-string">'Hello, world!'</span>)</span></span>
</code></pre>
<pre><code class="hljs css language-C"><span class="hljs-meta">#<span class="hljs-meta-keyword">include</span> <span class="hljs-meta-string">&lt;stdio.h&gt;</span></span>
<span class="hljs-function"><span class="hljs-keyword">int</span> <span class="hljs-title">main</span><span class="hljs-params">()</span> </span>{
<span class="hljs-built_in">printf</span>(<span class="hljs-string">"Hello World!"</span>);
<span class="hljs-keyword">return</span> <span class="hljs-number">0</span>;
}
</code></pre>
<pre><code class="hljs css language-Pascal">program HelloWorld;
begin
WriteLn('Hello, world!');
end.
```&lt;!--END_DOCUSAURUS_CODE_TABS--&gt;## Coloration syntaxique
La coloration syntaxique est activée par défaut sur les blocs de code clôturés. Le langage devrait être détectée automatiquement, mais vous pouvez parfois obtenir de meilleurs résultats en spécifiant le langage. Vous pouvez le faire à l'aide d'un [info string](https://github.github.com/gfm/#example-111), en suivant les trois backticks d'ouverture. L'exemple JavaScript suivant...
```js
ReactDOM.render(&lt;h1&gt;Hello, world!&lt;/h1&gt;, document.getElementById('root'));
```
...serait rendu avec la coloration syntaxique comme ceci :
```js
ReactDOM.render(&lt;h1&gt;Hello, world!&lt;/h1&gt;, document.getElementById('root'));
</code></pre>
<p>La mise en surbrillance est fournie par <a href="https://highlightjs.org">Highlight.js</a> en utilisant le thème spécifié dans votre fichier <code>siteConfig.js</code> dans la partie de la clé <code>highlight</code> :</p>
<pre><code class="hljs css language-js">{
...
highlight: {
<span class="hljs-attr">theme</span>: <span class="hljs-string">'default'</span>
}
...
}
</code></pre>
<p>Vous pouvez trouver la liste complète des thèmes pris en charge dans le dossier <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styles"><code>styles</code></a> deHighlight.js .</p>
<h3><a class="anchor" aria-hidden="true" id="ajout-de-langues-supplémentaires"></a><a href="#ajout-de-langues-supplémentaires" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Ajout de langues supplémentaires</h3>
<p>Bien que Highlight.js fournit le support pour <a href="https://highlightjs.org/static/demo/">de nombreux langages populaires</a>, vous pouvez trouver le besoin d'enregistrer un support linguistique supplémentaire. Pour ces cas, nous fournissons une issue de secours en exposant la constante <code>hljs</code> dans la clé de configuration <code>highlight</code>. Cela vous permet d'appeler <a href="http://highlightjs.readthedocs.io/en/latest/api.html#registerlanguage-name-language"><code>registerLanguage</code></a> :</p>
<pre><code class="hljs css language-js">{
...
highlight: {
<span class="hljs-attr">theme</span>: <span class="hljs-string">'default'</span>,
<span class="hljs-attr">hljs</span>: <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">hljs</span>) </span>{
hljs.registerLanguage(<span class="hljs-string">'galacticbasic'</span>, <span class="hljs-function"><span class="hljs-keyword">function</span>(<span class="hljs-params">hljs</span>) </span>{
<span class="hljs-comment">// ...</span>
});
}
}
}
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="utilisation-de-prism-comme-coloration-syntaxique-supplémentaire"></a><a href="#utilisation-de-prism-comme-coloration-syntaxique-supplémentaire" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Utilisation de Prism comme coloration syntaxique supplémentaire</h3>
<p>Vous pouvez également opter pour utiliser Prism de façon à surligner certains langages présent dans la liste <a href="https://github.com/PrismJS/prism/tree/master/components">ici</a>. Indiquez ces langages dans le champ <code>usePrism</code> dans votre <a href="api-site-config.md">siteConfig.js</a></p>
<p>Exemple :</p>
<pre><code class="hljs"><span class="hljs-comment">// siteConfig.js</span>
<span class="hljs-string">usePrism:</span> [<span class="hljs-string">'jsx'</span>]
</code></pre>
<p>Remarquez que le bloc de code au dessous utilise la syntaxe JSX formater avec Prism.</p>
<pre><code class="hljs css language-jsx"><span class="token keyword">class</span> <span class="token class-name">Example</span> <span class="token keyword">extends</span> <span class="token class-name">React<span class="token punctuation">.</span>Component</span> <span class="token punctuation">{</span>
<span class="token function">render</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token keyword">return</span> <span class="token punctuation">(</span>
<span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token class-name">View</span></span> <span class="token attr-name">style</span><span class="token script language-javascript"><span class="token script-punctuation punctuation">=</span><span class="token punctuation">{</span><span class="token punctuation">{</span>flex<span class="token punctuation">:</span> <span class="token number">1</span><span class="token punctuation">,</span> alignItems<span class="token punctuation">:</span> <span class="token string">'center'</span><span class="token punctuation">,</span> justifyContent<span class="token punctuation">:</span> <span class="token string">'center'</span><span class="token punctuation">}</span><span class="token punctuation">}</span></span><span class="token punctuation">></span></span><span class="token plain-text">
</span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token class-name">Text</span></span><span class="token punctuation">></span></span><span class="token plain-text">Docusaurus</span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span><span class="token class-name">Text</span></span><span class="token punctuation">></span></span><span class="token plain-text">
</span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;</span><span class="token class-name">Button</span></span>
<span class="token attr-name">title</span><span class="token attr-value"><span class="token punctuation">=</span><span class="token punctuation">"</span>Click me<span class="token punctuation">"</span></span>
<span class="token attr-name">onPress</span><span class="token script language-javascript"><span class="token script-punctuation punctuation">=</span><span class="token punctuation">{</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token operator">=></span> <span class="token keyword">this</span><span class="token punctuation">.</span>props<span class="token punctuation">.</span>navigation<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span><span class="token string">'Docusaurus'</span><span class="token punctuation">)</span><span class="token punctuation">}</span></span>
<span class="token punctuation">/></span></span><span class="token plain-text">
</span><span class="token tag"><span class="token tag"><span class="token punctuation">&lt;/</span><span class="token class-name">View</span></span><span class="token punctuation">></span></span>
<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="ajout-des-boutons-de-copie-de-code"></a><a href="#ajout-des-boutons-de-copie-de-code" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Ajout des boutons de copie de code</h3>
<p>Docusaurus permet d'ajouter des boutons pour copier le code dans des blocs de code clôturés. Veuillez suivre les instructions <a href="https://gist.github.com/yangshun/55db997ed0f8f4e6527571fc3bee4675">ici</a> pour ajouter les boutons &quot;Copier&quot; à vos blocs de code.</p>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/commands"><span class="arrow-prev">← </span><span>Commande CLI</span></a><a class="docs-next button" href="/docs/fr/api-pages"><span>Pages et styles</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#entêtes-de-markdown">Entêtes de Markdown</a><ul class="toc-headings"><li><a href="#documents">Documents</a></li><li><a href="#publications-de-blog">Publications de blog</a></li></ul></li><li><a href="#fonctionnalités-supplémentaires">Fonctionnalités supplémentaires</a><ul class="toc-headings"><li><a href="#lier-dautres-documents">Lier d'autres documents</a></li><li><a href="#lien-vers-les-images-et-autres-ressources">Lien vers les images et autres ressources</a></li><li><a href="#génération-dune-table-des-matières">Génération d'une table des matières</a></li><li><a href="#onglets-de-code-spécifiques-au-langage">Onglets de code spécifiques au langage</a></li><li><a href="#ajout-de-langues-supplémentaires">Ajout de langues supplémentaires</a></li><li><a href="#utilisation-de-prism-comme-coloration-syntaxique-supplémentaire">Utilisation de Prism comme coloration syntaxique supplémentaire</a></li><li><a href="#ajout-des-boutons-de-copie-de-code">Ajout des boutons de copie de code</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="sitemap"><a href="/" class="nav-home"><img src="/img/docusaurus_monochrome.svg" alt="Docusaurus" width="66" height="58"/></a><div class="footerSection"><h5>Docs</h5><a href="
/docs/fr/installation">Getting Started</a><a href="
/docs/fr/versioning">Versioning</a><a href="
/docs/fr/translation">Localization</a><a href="
/docs/fr/search">Adding Search</a></div><div class="footerSection"><h5>Community</h5><a href="/fr/help">Help</a><a href="/fr/users">User Showcase</a><a href="/fr/about-slash">About</a></div><div class="footerSection"><h5>Legal</h5><a href="https://opensource.facebook.com/legal/privacy/" target="_blank" rel="noreferrer noopener">Privacy</a><a href="https://opensource.facebook.com/legal/terms/" target="_blank" rel="noreferrer noopener">Terms</a></div><div class="footerSection"><h5>Social</h5><div class="social"><a class="github-button" href="https://github.com/facebook/docusaurus" data-count-href="https://github.com/facebook/docusaurus/stargazers" data-show-count="true" data-count-aria-label="# stargazers on GitHub" aria-label="Star this project on GitHub">docusaurus</a></div><div class="social"><a href="https://twitter.com/docusaurus" class="twitter-follow-button">Follow @docusaurus</a></div><div class="social"><div class="fb-like" data-href="https://docusaurus.io" data-colorscheme="dark" data-layout="standard" data-share="true" data-width="225" data-show-faces="false"></div></div></div></section><a href="https://opensource.facebook.com/" target="_blank" rel="noreferrer noopener" class="fbOpenSource"><img src="/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/></a><section class="copyright"><span>Copyright © 2020 Facebook Inc.</span> Landing images by <a href="https://undraw.co/">unDraw</a>.</section></footer></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>window.fbAsyncInit = function() {FB.init({appId:'199138890728411',xfbml:true,version:'v2.7'});};(function(d, s, id){var js, fjs = d.getElementsByTagName(s)[0];if (d.getElementById(id)) {return;}js = d.createElement(s); js.id = id;js.src = '//connect.facebook.net/en_US/sdk.js';fjs.parentNode.insertBefore(js, fjs);}(document, 'script','facebook-jssdk'));
</script><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script><script>
document.addEventListener('keyup', function(e) {
if (e.target !== document.body) {
return;
}
// keyCode for '/' (slash)
if (e.keyCode === 191) {
const search = document.getElementById('search_input_react');
search && search.focus();
}
});
</script><script>
var search = docsearch({
apiKey: '3eb9507824b8be89e7a199ecaa1a9d2c',
indexName: 'docusaurus',
inputSelector: '#search_input_react',
algoliaOptions: {"facetFilters":["language:fr","version:1.14.4"]}
});
</script></body></html>
Reference in a new issue View git blame Copy permalink