3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 16:29:47 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/website/README.md
Yangshun Tay 5d6dc49bcd
docs(v2): add docs skeleton and structure (#1412) 
* docs(v2): add docs skeleton and structure

* docs(v2): add on

* docs(v2): move motivation into contributing
2019-04-28 20:20:24 -07:00

1.1 KiB
Raw Blame History

Docusaurus 2 Website

Installation

  1. yarn install in the root of the repo (one level above this directory).
  2. In this directory, do yarn start.
  3. 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