CLI Commands · Docusaurus

Docusaurus îți furnizează un set de script-uri pentru a te ajuta să generezi, deservești și lansezi site-ul web. Aceste scripturi pot fi utilizate cu comanda run când utilizezi Yarn sau npm. Niște comenzi uzuale sunt:

yarn run start: construiește și deservește site-ul tău web dintr-un server local
yarn run exemple: crează exemplu de fișier de configurare

Rulează din linia de comandă

Script-urile pot fi rulate fie utilizând Yarn sau npm. Dacă deja ai trecut prin ghidul nostru Pentru a începe, este posibil să fii deja familiarizat cu comanda start. Este această comandă ce îi spune lui Docusaurus să ruleze script-ul docusaurus-start ce generează site-ul și pornește serverul și, de obicei, este utilizată așa:

yarn run start

Același script poate fi utilizat folosind npm:

npm run start

Pentru a rula un script particular, doar înlocuiește comanda start în exemplele de mai sus cu comanda asociată script-ului tău.

Folosind argumente

Some commands support optional arguments. For example, to start a server on port 8080, you can specify the --port argument when running start:

yarn run start --port 8080

Dacă rulezi Docusaurus folosind npm, poți încă să folosești argumente în linia de comandă prin inserarea a -- între npm run <command> și argumentele de comandă:

npm run start -- --port 8080

Configurație

Aceste script-uri sunt setate sub cheia "script-uri" în fișierul tău siteweb/pachet.json ca parte a procesului de instalare. Dacă ai nevoie de ajutor pentru a le seta din nou, te rugăm să apelezi la Ghidul de instalare.

Docusaurus furnizează niște mapări de bază ca să îți permită să rulezi comenzi ce implică convenții Node. În loc să tastezi docusaurus-start de fiecare dată, poți să tastezi yarn run start sau npm start pentru a realiza același lucru.

Referințe

`docusaurus-build`

Alias: build.

Options	Default	Description
`--skip-image-compression`	`false`	Skip compression of image assets. You usually won't want to skip this unless your images have already been optimized.
`--skip-next-release`	`false`	Skip the next release documents when versioning is enabled. This will not build HTML files for documents in `/docs` directory.

Generates the static website, applying translations if necessary. Useful for building the website prior to deployment.

`docusaurus-examples`

Alias: exemple

Arguments	Default	Description
`<feature>`	-	Specify a feature `translations` or `versions` to generate the extra example files for that feature.

Example

docusaurus-examples <feature>

When no feature is specified, sets up a minimally configured example website in your project. This command is covered in depth in the Site Preparation guide.

`docusaurus-publică`

Alias: publish-gh-pages

Builds, then deploys the static website to 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:

The following environment variables are generally set manually by the user in the CircleCI config.yml file.

GIT_UTILIZATOR: Utilizatorul git pentru a fi asociat cu commit-ul de lansare.
USE_SSH: Whether to use SSH instead of HTTPS for your connection to the GitHub repo.

Example

GIT_USER=docusaurus-bot USE_SSH=true yarn run publish-gh-pages

The following environment variables are set by CircleCI during the build process.

CIRCLE_BRANCH: Ramura git pentru a fi asociat cu commit-ul ce a declanșat rularea CI.
CI_PULL_REQUEST: Se așteaptă să fie truthy dacă rularea CI a fost declanșată de un commit într-o cerere de tip pull.

The following should be set by you in siteConfig.js as organizationName and projectName, respectively. If they are not set in your site configuration, they fall back to the CircleCI environment.

CIRCLE_PROJECT_USERNAME: The GitHub username or organization name that hosts the Git repo, e.g. "facebook".
CIRCLE_PROJECT_REPONAME: The name of the Git repo, e.g. "Docusaurus".

You can learn more about configuring automatic deployments with CircleCI in the Publishing guide.

`docusaurus-rename-version`

Alias: rename-version

Renames an existing version of the docs to a new version name.

Arguments	Default	Description
`<currentVersion>`	-	Version to be renamed.
`<newVersion>`	-	Version to be renamed to.

Example

docusaurus-rename-version <currentVersion> <newVersion>

See the Versioning guide to learn more.

`docusaurus-start`

Alias: start.

This command will build the static website, apply translations if necessary, and then start a local server.

Options	Default	Description
`--port <number>`	`3000`	The website will be served from port 3000 by default, but if the port is taken up, Docusaurus will attempt to find an available one.
`--watch`	-	Whether to watch the files and live reload the page when files are changed. Defaults to true. Disable this by using `--no-watch`.

You can specify the browser application to be opened by setting the BROWSER environment variable before the command, e.g.:

$ BROWSER=firefox yarn start

`docusaurus-versiune <versiune>`

Alias: version

Generates a new version of the docs. This will result in a new copy of your site being generated and stored in its own versioned directory. Useful for capturing snapshots of API docs that map to specific versions of your software. Accepts any string as a version number.

See the Versioning guide to learn more.

`docusaurus-scrie-traduceri`

Alias: write-translations

Writes the English for any strings that need to be translated into an website/i18n/en.json file. The script will go through every file in website/pages/en and through the siteConfig.js file and other config files to fetch English strings that will then be translated on Crowdin. See the Translation guide to learn more.