mirror of https://github.com/facebook/docusaurus.git synced 2025-05-01 11:18:24 +02:00

History

Yangshun Tay c75cec76ec misc: update Docusaurus 2 URL		2019-05-26 16:43:28 -07:00
..
docs	docs(v2): introduction (#1501 )	2019-05-21 18:56:42 -07:00
pages	chore(v2): cleanup & update deps (#1505 )	2019-05-22 19:20:53 +07:00
scripts	chore: move to monorepo (#1297 )	2019-03-23 14:21:36 +07:00
static/img	feat(v2): use Infima CSS (#1346 )	2019-04-09 00:48:37 -07:00
docusaurus.config.js	misc: update Docusaurus 2 URL	2019-05-26 16:43:28 -07:00
package.json	v2.0.0-alpha.16	2019-05-16 16:01:52 +08:00
README.md	docs(v2): add docs skeleton and structure (#1412 )	2019-04-28 20:20:24 -07:00
sidebars.js	chore(v2): fix typo	2019-05-15 19:35:14 +08: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