History

Wei Gao 22ed720faa docs(v2): revise "writing docs" (#1561 ) * Revise doc on writing docs * More work on docs doc * misc(v2): tweak docs * misc(v2): fix typo		2019-06-05 13:45:40 -07:00
..
components/BrowserWindow	docs(v2): revise "writing docs" (#1561 )	2019-06-05 13:45:40 -07:00
css	…
docs	docs(v2): revise "writing docs" (#1561 )	2019-06-05 13:45:40 -07:00
pages	…
scripts	…
static/img	…
README.md	…
docusaurus.config.js	…
package.json	…
sidebars.js	docs(v2): revise "writing docs" (#1561 )	2019-06-05 13:45:40 -07:00

README.md

Docusaurus 2 Website

Installation

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