mirror of
https://github.com/facebook/docusaurus.git
synced 2025-12-30 14:14:17 +00:00
5d6dc49bcd
* docs(v2): add docs skeleton and structure * docs(v2): add on * docs(v2): move motivation into contributing
50 lines
1.1 KiB
Markdown
50 lines
1.1 KiB
Markdown
# Docusaurus 2 Website
|
|
|
|
## Installation
|
|
|
|
1. `yarn install` in the root of the repo (one level above this directory).
|
|
1. In this directory, do `yarn start`.
|
|
1. A browser window will open up, pointing to the docs.
|
|
|
|
### Information Hierarchy
|
|
|
|
This is a high-level overview of the content of the docs:
|
|
|
|
```
|
|
├─ Getting Started
|
|
│ ├─ Introduction
|
|
│ ├─ Motivation
|
|
│ ├─ Installation
|
|
│ ├─ Project Structure
|
|
│ └─ Deployment
|
|
│
|
|
├─ Guides
|
|
│ ├─ Configuration
|
|
│ ├─ Creating Pages
|
|
│ ├─ Writing Documentation
|
|
│ ├─ Using Assets
|
|
│ ├─ Markdown Features
|
|
│ ├─ Styling and Layout
|
|
│ ├─ Using Plugins
|
|
│ ├─ Using Themes
|
|
│ ├─ Adding Search
|
|
│ └─ Adding Analytics
|
|
│
|
|
├─ Advanced Guides
|
|
│ ├─ Blog
|
|
│ ├─ Plugins
|
|
│ ├─ Themes
|
|
│ ├─ Presets
|
|
│ └─ How Docusaurus Works
|
|
│
|
|
├─ API Reference
|
|
│ ├─ CLI
|
|
│ ├─ Docusaurus core
|
|
│ ├─ docusaurus.config.js
|
|
│ └─ Plugins
|
|
│
|
|
├─ Contributing
|
|
│ ├─ How to Contribute
|
|
│ └─ Design Principles
|
|
```
|