mirror of
https://github.com/facebook/docusaurus.git
synced 2025-05-11 08:07:26 +02:00
236 lines
No EOL
37 KiB
HTML
236 lines
No EOL
37 KiB
HTML
<!DOCTYPE html><html lang="ru"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>CLI Commands · Docusaurus</title><meta name="viewport" content="width=device-width"/><meta name="generator" content="Docusaurus"/><meta name="description" content="Docusaurus предоставляет набор сценариев, которые помогут вам создавать, обслуживать и развертывать ваш веб-сайт. Эти сценарии могут быть вызваны с помощью команды `run` в Yarn или npm. Наиболее распространенные команды:"/><meta name="docsearch:version" content="1.14.4"/><meta name="docsearch:language" content="ru"/><meta property="og:title" content="CLI Commands · Docusaurus"/><meta property="og:type" content="website"/><meta property="og:url" content="https://docusaurus.io/"/><meta property="og:description" content="Docusaurus предоставляет набор сценариев, которые помогут вам создавать, обслуживать и развертывать ваш веб-сайт. Эти сценарии могут быть вызваны с помощью команды `run` в Yarn или npm. Наиболее распространенные команды:"/><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="/ru"><img class="logo" src="/img/docusaurus.svg" alt="Docusaurus"/><h2 class="headerTitleWithLogo">Docusaurus</h2></a><a href="/ru/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/ru/installation" target="_self">Документация</a></li><li class=""><a href="/docs/ru/tutorial-setup" target="_self">Руководство</a></li><li class=""><a href="/ru/users" target="_self">Пользователи</a></li><li class=""><a href="/blog/" target="_self">Блог</a></li><li class=""><a href="https://github.com/facebook/docusaurus" target="_blank">GitHub</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>Русский</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/en/commands">English</a></li><li><a href="/docs/fr/commands">Français</a></li><li><a href="/docs/ko/commands">한국어</a></li><li><a href="/docs/pt-BR/commands">Português (Brasil)</a></li><li><a href="/docs/ro/commands">Română</a></li><li><a href="/docs/zh-CN/commands">简体中文</a></li><li><a href="https://crowdin.com/project/docusaurus" target="_blank" rel="noreferrer noopener">Помочь с переводом</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">Начало работы<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/ru/installation">Installation</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/site-preparation">Site Preparation</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/site-creation">Creating your site</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/publishing">Publishing your site</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/docker">Docker</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle collapsible">Руководство<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/ru/adding-blog">Adding a Blog</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/custom-pages">Custom Pages</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/search">Enabling Search</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/navigation">Navigation and Sidebars</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/translation">Translations & Localization</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/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 navListItemActive"><a class="navItem" href="/docs/ru/commands">CLI Commands</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/doc-markdown">Markdown Features</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/api-pages">Pages and Styles</a></li><li class="navListItem"><a class="navItem" href="/docs/ru/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/ru" target="_blank" rel="noreferrer noopener">Translate</a><h1 id="__docusaurus" class="postHeaderTitle">CLI Commands</h1></header><article><div><span><p>Docusaurus предоставляет набор сценариев, которые помогут вам создавать, обслуживать и развертывать ваш веб-сайт. Эти сценарии могут быть вызваны с помощью команды <code>run</code> в Yarn или npm. Наиболее распространенные команды:</p>
|
||
<ul>
|
||
<li><a href="/docs/ru/commands#docusaurus-start-port-number"><code>yarn run start</code></a>: построить и запустить сайт на локальном сервере</li>
|
||
<li><a href="/docs/ru/commands#docusaurus-examples"><code>yarn run examples</code></a>: создать образец файлов конфигурации</li>
|
||
</ul>
|
||
<h2><a class="anchor" aria-hidden="true" id="запуск-из-командной-строки"></a><a href="#запуск-из-командной-строки" 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>Запуск из командной строки</h2>
|
||
<p>Сценарии можно запустить с помощью Yarn или npm. Если вы уже прочитали руководство по началу работы, то вы уже должны быть знакомы с командой <code>start</code>. Эта команда указывает Docusaurus запустить сценарий <code>docusaurus-start</code>, который создаст сайт и запустит сервер, данную команду можно вызвать следующим образом:</p>
|
||
<pre><code class="hljs css language-bash">yarn run start
|
||
</code></pre>
|
||
<p>Данный сценарий можно также запустить с помощью npm:</p>
|
||
<pre><code class="hljs css language-bash">npm run start
|
||
</code></pre>
|
||
<p>Чтобы запустить отдельный сценарий, просто замените команду <code>start</code> в примере выше на команду, которая запускает ваш сценарий.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="параметры-командной-строки"></a><a href="#параметры-командной-строки" 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>Параметры командной строки</h2>
|
||
<p>Некоторые команды поддерживают необязательные параметры. Например, чтобы сервер использовал порт 8080, вы можете указать параметр <code>--port</code> во время запуска команды <code>start</code>:</p>
|
||
<pre><code class="hljs css language-bash">yarn run start --port 8080
|
||
</code></pre>
|
||
<p>Если вы запускаете Docusaurus с помощью npm, вы также можете использовать параметры командной строки, вставив <code>--</code> между <code>npm run <command></code> и параметрами команды:</p>
|
||
<pre><code class="hljs css language-bash">npm run start -- --port 8080
|
||
</code></pre>
|
||
<h2><a class="anchor" aria-hidden="true" id="настройка"></a><a href="#настройка" 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>Настройка</h2>
|
||
<p>Команды описаны в секции <code>"scripts"</code> файла <code>website/package.json</code> как часть процесса установки. Если требуется помощь в их настройке, обратитесь, пожалуйста, к <a href="/docs/ru/installation">руководству по установке</a>.</p>
|
||
<p>Docusaurus по-умолчанию сопоставляет всем командам краткие псевдонимы, позволяя запускать их в соответствии с соглашениями Node. Вместо того, чтобы вводить <code>docusaurus-start</code> каждый раз, вы можете ввести <code>yarn run start</code> или <code>npm run start</code> чтобы достигнуть такого же результата.</p>
|
||
<h2><a class="anchor" aria-hidden="true" id="команды"></a><a href="#команды" 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>Команды</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-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="справка"></a><a href="#справка" 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>Справка</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>Псевдоним: <code>build</code>.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Параметр</th><th>По-умолчанию</th><th>Описание</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>--skip-image-compression</code></td><td><code>false</code></td><td>Пропустить этап сжатия изображений. Вы можете указать этот параметр, если ваши изображения уже были оптимизированы и дополнительное сжатие не требуется.</td></tr>
|
||
<tr><td><code>--skip-next-release</code></td><td><code>false</code></td><td>Пропустить документы следующего релиза, если включено управление версиями. Это не приведет к созданию HTML-файлов для документов в каталоге <code>/docs</code>.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Создает статический веб-сайт, применяя перевод текста, если необходимо. Полезно для построения веб-сайта до развертывания.</p>
|
||
<p>Смотрите также <a href="/docs/ru/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>Псевдоним: <code>examples</code></p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Аргумент</th><th>По-умолчанию</th><th>Описание</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code><feature></code></td><td>-</td><td>Укажите характеристику <code>translations</code> или <code>versions</code> для создания дополнительных файлов-примеров для неё.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>Пример</strong></p>
|
||
<pre><code class="hljs css language-bash">docusaurus-examples <feature>
|
||
</code></pre>
|
||
<p>В случае, если характеристика не указана, будет создан образец веб-сайта с настройками по-умолчанию. Подробное описание данной команды можно найти в <a href="/docs/ru/site-preparation">руководстве по настройке сайта</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>Псевдоним: <code>publish-gh-pages</code></p>
|
||
<p><a href="/docs/ru/commands#docusaurus-build">Строит</a>, затем развертывает статический веб-сайт на GitHub Pages. Эта команда предназначена для запуска на этапе развертывания в CircleCI и, следовательно, ожидает определения нескольких переменных среды:</p>
|
||
<p>Переменные окружения, представленные ниже, обычно устанавливаются пользователем вручную в файле CircleCI <code>config.yml</code>.</p>
|
||
<ul>
|
||
<li><code>GIT_USER</code>: Пользователь git, к которому относится коммит развертывания.</li>
|
||
<li><code>USE_SSH</code>: Нужно ли использовать SSH вместо HTTPS для вашего подключения к репозиторию GitHub.</li>
|
||
</ul>
|
||
<p><strong>Пример</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>Следующие переменные окружения <a href="https://circleci.com/docs/1.0/environment-variables/">устанавливаются в CircleCI</a> во процессе сборки.</p>
|
||
<ul>
|
||
<li><code>CIRCLE_BRANCH</code>: Ветка git, в которой был сделан коммит, запустивший CI.</li>
|
||
<li><code>CI_PULL_REQUEST</code>: Параметр равен true, если текущий запуск CI был осуществлен коммитом из pull-запроса.</li>
|
||
</ul>
|
||
<p>Следующие переменные должны быть определены в <code>siteConfig.js</code> как <code>organizationName</code> и <code>projectName</code>, соответственно. Если они не определены в конфигурации вашего сайта, то будут использованы настройки из <a href="https://circleci.com/docs/1.0/environment-variables/">окружения CircleCI</a>.</p>
|
||
<ul>
|
||
<li><code>CIRCLE_PROJECT_USERNAME</code>: Пользователь GitHub или наименование организации, предоставляющей репозиторий Git, например "facebook".</li>
|
||
<li><code>CIRCLE_PROJECT_REPONAME</code>: Наименование репозитория Git, например "Docusaurus".</li>
|
||
</ul>
|
||
<p>Вы можете узнать больше о настройке автоматического развертывания с помощью CircleCI в <a href="/docs/ru/publishing">руководстве по публикации сайта</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>Псевдоним: <code>rename-version</code></p>
|
||
<p>Изменяет наименование существующей версии на новое.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Аргумент</th><th>По-умолчанию</th><th>Описание</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code><currentVersion></code></td><td>-</td><td>Версия, которая будет переименована.</td></tr>
|
||
<tr><td><code><newVersion></code></td><td>-</td><td>Версия, которая будет после переименования.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p><strong>Пример</strong></p>
|
||
<pre><code class="hljs css language-bash">docusaurus-rename-version <currentVersion> <newVersion>
|
||
</code></pre>
|
||
<p>Обратитесь к <a href="/docs/ru/versioning#renaming-existing-versions">руководству по версионированию</a>, чтобы узнать больше.</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>Псевдоним: <code>start</code>.</p>
|
||
<p>Данная команда создает статический веб-сайт, применяет перевод текста при необходимости, затем запускает локальный сервер.</p>
|
||
<table>
|
||
<thead>
|
||
<tr><th>Параметр</th><th>По-умолчанию</th><th>Описание</th></tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr><td><code>--port <number></code></td><td><code>3000</code></td><td>Веб-сайт по-умолчанию использует порт 3000, но если порт занят, то Docusaurus попробует найти доступный порт самостоятельно.</td></tr>
|
||
<tr><td><code>--host <host></code></td><td><code>localhost</code></td><td>Укажите используемый хост. Например, если ваш сервер доступен снаружи, используйте --host 0.0.0.0.</td></tr>
|
||
<tr><td><code>--watch</code></td><td>-</td><td>Следует ли отслеживать файлы и перезагружать страницу при изменении файлов. Используется по-умолчанию. Отключить отслеживание можно с помощью параметра <code>--no-watch</code>.</td></tr>
|
||
</tbody>
|
||
</table>
|
||
<p>Вы можете указать браузер, под которым откроется сайт после сборки, указав переменную окружения <code>BROWSER</code> перед вызовом команды, т.е.:</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>Псевдоним: <code>version</code></p>
|
||
<p>Создает новую версию документов. В результате будет создана новая копия вашего сайта и будет сохранена в отдельном каталоге с указанной версией. Данная команда полезна для создания снимков состояния документации API, отражающей особенности версий вашего ПО. В качестве номера версии можно указать любую строку.</p>
|
||
<p>Обратитесь к <a href="/docs/ru/versioning">руководству по версионированию</a>, чтобы узнать больше.</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>Псевдоним: <code>write-translations</code></p>
|
||
<p>Записывает английский для любых строк, которые должны быть переведены в файл <code>website/i18n/ru.json</code>. Сценарий пройдет по всем файлам в каталоге <code>website/pages/en</code>, использует файл <code>siteConfig.js</code>, а также другие файлы с настройками, чтобы получить строки на английском языке, которые затем будут переведены с помощью Crowdin. Обратитесь к <a href="/docs/ru/translation">руководству по переводу</a>, чтобы узнать больше.</p>
|
||
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/ru/versioning"><span class="arrow-prev">← </span><span>Версионирование</span></a><a class="docs-next button" href="/docs/ru/doc-markdown"><span>Особенности разметки Markdown в Docusaurus</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#запуск-из-командной-строки">Запуск из командной строки</a></li><li><a href="#параметры-командной-строки">Параметры командной строки</a></li><li><a href="#настройка">Настройка</a></li><li><a href="#команды">Команды</a></li><li><a href="#справка">Справка</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-version"><code>docusaurus-version <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/ru/installation">Getting Started</a><a href="
|
||
/docs/ru/versioning">Versioning</a><a href="
|
||
/docs/ru/translation">Localization</a><a href="
|
||
/docs/ru/search">Adding Search</a></div><div class="footerSection"><h5>Community</h5><a href="/ru/help">Help</a><a href="/ru/users">User Showcase</a><a href="/ru/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:ru","version:1.14.4"]}
|
||
});
|
||
</script></body></html> |