mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-12 16:47:26 +02:00
236 lines
No EOL
32 KiB
HTML
236 lines
No EOL
32 KiB
HTML
<!DOCTYPE html><html lang="fr"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Commande CLI · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Docusaurus met à disposition un ensemble de scripts vous aidant dans la génération, le lancement et le déploiement de votre site web. Ces scripts peuvent être lancés avec la commande `run` lorsque vous utilisez Yarn ou npm. Les commandes générales sont:"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="fr"/><meta property="og:title" content="Commande CLI · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="Docusaurus met à disposition un ensemble de scripts vous aidant dans la génération, le lancement et le déploiement de votre site web. Ces scripts peuvent être lancés avec la commande `run` lorsque vous utilisez Yarn ou npm. Les commandes générales sont:"/><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>next</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/fr/next/installation" target="_self">Documentations</a></li><li class=""><a href="/docs/fr/next/tutorial-setup" target="_self">Tutorial</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/next/commands">English</a></li><li><a href="/docs/ko/next/commands">한국어</a></li><li><a href="/docs/pt-BR/next/commands">Português (Brasil)</a></li><li><a href="/docs/ro/next/commands">Română</a></li><li><a href="/docs/ru/next/commands">Русский</a></li><li><a href="/docs/zh-CN/next/commands">简体中文</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/next/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/site-preparation">Préparation du site</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/site-creation">Création de votre site</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/publishing">Publication de votre site</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/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/next/adding-blog">Ajouter un blog</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/custom-pages">Pages personnalisées</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/search">Activation de la recherche</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/navigation">Navigation et Barre latérale</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/translation">Traductions & Localisation</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/versioning">Gestion de version</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 navListItemActive"><a class="navItem" href="/docs/fr/next/commands">Commande CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/doc-markdown">Fonctionnalités de Markdown</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/api-pages">Pages et styles</a></li><li class="navListItem"><a class="navItem" href="/docs/fr/next/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"><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 class="postHeaderTitle">Commande CLI</h1></header><article><div><span><p>Docusaurus met à disposition un ensemble de scripts vous aidant dans la génération, le lancement et le déploiement de votre site web. Ces scripts peuvent être lancés avec la commande <code>run</code> lorsque vous utilisez Yarn ou npm. Les commandes générales sont:</p>
|
||
<ul>
|
||
<li><a href="/docs/fr/next/commands#docusaurus-start-port-number"><code>yarn run start</code></a>: génère et lance le site web via un serveur local</li>
|
||
<li><a href="/docs/fr/next/commands#docusaurus-examples"><code>yarn run examples</code></a>: crée les fichiers de configurations de l'exemple</li>
|
||
</ul>
|
||
<h2><a class="anchor" aria-hidden="true" id="utilisation-depuis-linterface-de-commande"></a><a href="#utilisation-depuis-linterface-de-commande" 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 depuis l'interface de commande</h2>
|
||
<p>Ces scripts peuvent être utilisé soit avec Yarn soit avec npm. Si vous avez déjà regardé notre guide sur Comment Commencer, vous devez donc déjà être familier avec la commande <code>start</code>. C'est la commande qui demande à Docusaurus de lancer le script <code>docusaurus-start</code> qui va générer le site et préparer le serveur, il est généralement lancé comme ça:</p>
|
||
<pre><code class="hljs css language-bash">yarn run start
|
||
</code></pre>
|
||
<p>Le même script peut être lancé via npm:</p>
|
||
<pre><code class="hljs css language-bash">npm run start
|
||
</code></pre>
|
||
<p>Pour lancer un script particulier, remplacez tout simplement la commande <code>start</code> dans l'exemple au dessus par la commande associée par votre script.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="utilisation-avec-des-arguments"></a><a href="#utilisation-avec-des-arguments" 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 avec des arguments</h2>
|
||
<p>Certaines commandes possèdent des arguments qui sont optionnels. Par exemple, pour lancer le serveur sur le port 8080, vous pouvez spécifier le paramètre <code>--port</code> quand vous lancez la commande <code>start</code>:</p>
|
||
<pre><code class="hljs css language-bash">yarn run start --port 8080
|
||
</code></pre>
|
||
<p>Si vous lancez Docusaurus via npm, vous pouvez également utiliser les arguments des commandes en insérant <code>--</code> entre <code>npm run<command></code> et les arguments de la commande:</p>
|
||
<pre><code class="hljs css language-bash">npm run start -- --port 8080
|
||
</code></pre>
|
||
<h2><a class="anchor" aria-hidden="true" id="configuration"></a><a href="#configuration" 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>Configuration</h2>
|
||
<p>Ces scripts sont mis en place sous la clé <code>"scripts"</code> dans votre fichier <code>website/package.json</code> dans le cadre du processus d’installation. Si vous avez besoin d'aide durant leur mise en place, merci de vous référer au <a href="/docs/fr/next/installation">guide d'installation</a>.</p>
|
||
<p>Docusaurus met à votre disposition des mappings par défauts vous permettant de lancer les commandes en respectant les conventions de Node. A la place de taper <code>docusaurus-start</code> à chaque fois, vous pouvez taper <code>yarn run start</code> ou <code>npm start</code> pour arriver au même résultat.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="les-commandes"></a><a href="#les-commandes" 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>Les Commandes</h2>
|
||
<ul>
|
||
<li><a href="#docusaurus-build"><code>docusaurus-build</code></a></li>
|
||
<li><a href="#docusaurus-examples"><code>docusaurus-examples</code></a></li>
|
||
<li><a href="#docusaurus-publish"><code>docusaurus-publish</code></a></li>
|
||
<li><a href="#docusaurus-rename-version"><code>docusaurus-rename-version</code></a></li>
|
||
<li><a href="#docusaurus-start"><code>docusaurus-start</code></a></li>
|
||
<li><a href="#docusaurus-version"><code>docusaurus-version <version></code></a></li>
|
||
<li><a href="#docusaurus-write-translations"><code>docusaurus-write-translations</code></a></li>
|
||
</ul>
|
||
<hr>
|
||
<h2><a class="anchor" aria-hidden="true" id="reference"></a><a href="#reference" 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>Référence</h2>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-build"></a><a href="#docusaurus-build" 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><code>docusaurus-build</code></h3>
|
||
<p>Alias: <code>build</code>.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Options</th><th>Défault</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>--skip-image-compression</code></td><td><code>false</code></td><td>Saute la compression de l'image. Généralement, vous ne voulez pas sauter cette étape à moins que vos images aient été déjà optimisés.</td></tr>
|
||
<tr><td><code>--skip-next-release</code></td><td><code>false</code></td><td>Skip the next release documents when versioning is enabled. This will not build HTML files for documents in <code>/docs</code> directory.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Génère le site Web statique, appliquant des traductions si nécessaire. Utile pour construire le site avant le déploiement.</p>
|
||
<p>Voir aussi <a href="/docs/fr/next/commands#docusaurus-start"><code>docusaurus-start</code></a>.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-examples"></a><a href="#docusaurus-examples" 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><code>docusaurus-examples</code></h3>
|
||
<p>Alias: <code>examples</code></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Arguments</th><th>Défault</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code><feature></code></td><td>-</td><td>Spécifier des caractéristiques <code>translations</code> ou <code>versions</code> pour générer des fichiers supplémentaires pour cette caractéristique.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>Exemple</strong></p>
|
||
<pre><code class="hljs css language-bash">docusaurus-examples <feature>
|
||
</code></pre>
|
||
<p>Lorsqu'il n'y a pas de caractéristiques spécifiées, génère un petit site web d'exemple prêt à l'utilisation dans vos projets. Cette commande est expliquée en profondeur dans le <a href="/docs/fr/next/site-preparation">guide de Préparation de votre site</a>.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-publish"></a><a href="#docusaurus-publish" 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><code>docusaurus-publish</code></h3>
|
||
<p>Alias: <code>publish-gh-pages</code></p>
|
||
<p><a href="/docs/fr/next/commands#docusaurus-build">Builds</a>, puis déploie le site web statique sur GitHub Pages. This command is meant to be run during the deployment step in CircleCI, and therefore expects a few environment variables to be defined:</p>
|
||
<p>Ces variables d'environnements sont généralement définies manuellement par l'utilisateur dans le fichier de configuration CircleCI <code>config.yml</code>.</p>
|
||
<ul>
|
||
<li><code>GIT_USER</code>: L'utilisateur git qui doit être associé au commit de déploiement.</li>
|
||
<li><code>USE_SSH</code>: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.</li>
|
||
</ul>
|
||
<p><strong>Exemple</strong></p>
|
||
<pre><code class="hljs css language-bash">GIT_USER=docusaurus-bot USE_SSH=<span class="hljs-literal">true</span> yarn run publish-gh-pages
|
||
</code></pre>
|
||
<p>The following environment variables are <a href="https://circleci.com/docs/1.0/environment-variables/">set by CircleCI</a> during the build process.</p>
|
||
<ul>
|
||
<li><code>CIRCLE_BRANCH</code>: La branche qui doit être associée au commit qui à démarré le processus CI.</li>
|
||
<li><code>CI_PULL_REQUEST</code>: devrait être correcte si l’actuel tâche CI a été déclenché par un commit dans un pull request.</li>
|
||
</ul>
|
||
<p>The following should be set by you in <code>siteConfig.js</code> as <code>organizationName</code> and <code>projectName</code>, respectively. If they are not set in your site configuration, they fall back to the <a href="https://circleci.com/docs/1.0/environment-variables/">CircleCI environment</a>.</p>
|
||
<ul>
|
||
<li><code>CIRCLE_PROJECT_USERNAME</code>: nom d’utilisateur GitHub ou de l’organisation qui héberge le repo Git, par exemple "facebook".</li>
|
||
<li><code>CIRCLE_PROJECT_REPONAME</code>: le nom du repo Git, par exemple "Docusaurus".</li>
|
||
</ul>
|
||
<p>You can learn more about configuring automatic deployments with CircleCI in the <a href="/docs/fr/next/publishing">Publishing guide</a>.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-rename-version"></a><a href="#docusaurus-rename-version" 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><code>docusaurus-rename-version</code></h3>
|
||
<p>Alias: <code>rename-version</code></p>
|
||
<p>Renames an existing version of the docs to a new version name.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Arguments</th><th>Défault</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code><currentVersion></code></td><td>-</td><td>Version à renommer.</td></tr>
|
||
<tr><td><code><newVersion></code></td><td>-</td><td>Version qui doit être renommée.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>Exemple</strong></p>
|
||
<pre><code class="hljs css language-bash">docusaurus-rename-version <currentVersion> <newVersion>
|
||
</code></pre>
|
||
<p>See the <a href="/docs/fr/next/versioning#renaming-existing-versions">Versioning guide</a> to learn more.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-start"></a><a href="#docusaurus-start" 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><code>docusaurus-start</code></h3>
|
||
<p>Alias: <code>start</code>.</p>
|
||
<p>This command will build the static website, apply translations if necessary, and then start a local server.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Options</th><th>Défault</th><th>Description</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>--port <number></code></td><td><code>3000</code></td><td>Le site web est accessible par défaut sur le port 3000, mais si le port est déjà utilisé Docusaurus va essayer d'en trouver un de libre.</td></tr>
|
||
<tr><td><code>--host <host></code></td><td><code>localhost</code></td><td>Specify a host to use. E.g., if you want your server to be accessible externally, you can use --host 0.0.0.0.</td></tr>
|
||
<tr><td><code>--watch</code></td><td>-</td><td>Regarde les fichiers et actualise la page lorsque des modifications ont été apporté. La valeur par défaut est true. Vous pouvez désactiver cette mécanique en utilisant <code>--no-cache</code>.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>You can specify the browser application to be opened by setting the <code>BROWSER</code> environment variable before the command, e.g.:</p>
|
||
<pre><code class="hljs">$ BROWSER=firefox yarn start
|
||
</code></pre>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-version-version"></a><a href="#docusaurus-version-version" 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><code>docusaurus-version <version></code></h3>
|
||
<p>Alias: <code>version</code></p>
|
||
<p>Generates a new version of the docs. Cela va créer par une nouvelle copie de votre site, générée et stockée dans son propre répertoire versionné. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.</p>
|
||
<p>See the <a href="/docs/fr/next/versioning">Versioning guide</a> to learn more.</p>
|
||
<hr>
|
||
<h3><a class="anchor" aria-hidden="true" id="docusaurus-write-translations"></a><a href="#docusaurus-write-translations" 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><code>docusaurus-write-translations</code></h3>
|
||
<p>Alias: <code>write-translations</code></p>
|
||
<p>Writes the English for any strings that need to be translated into a <code>website/i18n/en.json</code> file. The script will go through every file in <code>website/pages/en</code> and through the <code>siteConfig.js</code> file and other config files to fetch English strings that will then be translated on Crowdin. See the <a href="/docs/fr/next/translation">Translation guide</a> to learn more.</p>
|
||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/fr/next/versioning"><span class="arrow-prev">← </span><span>Gestion de version</span></a><a class="docs-next button" href="/docs/fr/next/doc-markdown"><span>Fonctionnalités de Markdown</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#utilisation-depuis-linterface-de-commande">Utilisation depuis l'interface de commande</a></li><li><a href="#utilisation-avec-des-arguments">Utilisation avec des arguments</a></li><li><a href="#configuration">Configuration</a></li><li><a href="#les-commandes">Les Commandes</a></li><li><a href="#reference">Référence</a><ul class="toc-headings"><li><a href="#docusaurus-build"><code>docusaurus-build</code></a></li><li><a href="#docusaurus-examples"><code>docusaurus-examples</code></a></li><li><a href="#docusaurus-publish"><code>docusaurus-publish</code></a></li><li><a href="#docusaurus-rename-version"><code>docusaurus-rename-version</code></a></li><li><a href="#docusaurus-start"><code>docusaurus-start</code></a></li><li><a href="#docusaurus-version"><code>docusaurus-version</code></a></li><li><a href="#docusaurus-write-translations"><code>docusaurus-write-translations</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>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 © 2019 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:next"]}
|
||
});
|
||
</script></body></html> |