# docusaurus-init

> Initialization script for Docusaurus

Latest version **1.14.7** (published 2021-03-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install docusaurus-init
pnpm add docusaurus-init
yarn add docusaurus-init
bun add docusaurus-init
```

Provides the command `docusaurus-init`.

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.14.7 |
| Published | 2021-03-09 |
| First published | 2017-09-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 2.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 66322 |
| Maintainers | yangshun, slorber, joelmarcey, lex111, docusaurus-bot |
| Keywords | documentation, websites, open source, docusaurus |

## Links

- npm: https://www.npmjs.com/package/docusaurus-init
- Repository: https://github.com/facebook/docusaurus
- npm.io page: https://npm.io/package/docusaurus-init

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.4

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.14.7 (latest) — 2021-03-09
- 2.0.0-alpha.66 (next) — 2020-10-19
- 2.0.0-alpha.65 — 2020-10-02
- 2.0.0-alpha.64 — 2020-09-11
- 2.0.0-alpha.63 — 2020-09-03
- 2.0.0-alpha.62 — 2020-08-28
- 2.0.0-alpha.61 — 2020-08-01
- 2.0.0-alpha.60 — 2020-07-29
- 2.0.0-alpha.59 — 2020-07-24
- 2.0.0-alpha.58 — 2020-06-18
- 2.0.0-alpha.56 — 2020-05-27
- 2.0.0-alpha.55 — 2020-05-19
- 2.0.0-alpha.54 — 2020-04-28
- 2.0.0-alpha.53 — 2020-04-27
- 2.0.0-alpha.52 — 2020-04-27
- … 43 more at https://npm.io/package/docusaurus-init/versions

## README

## `docusaurus-init`

An initialization script for [Docusaurus](https://docusaurus.io).

### What does it do?

Docusaurus was designed from the ground up to be easily installed and used to get your website up an running quickly. To install Docusaurus, we have created an easy script that will get all of the infrastructure setup for you:

1. Have Node >= 8.x installed. Yarn >= 1.5 is recommended as well.
1. Go into the root of your GitHub repo directory where you will be creating the docs.
1. `npx docusaurus-init`

> If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run yarn global add docusaurus-init or npm install --global docusaurus-init. After that, run docusaurus-init.

Find out more in the [official docs](https://docusaurus.io/docs/en/installation).

---
_Source: https://npm.io/package/docusaurus-init · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._