mirror of https://github.com/facebook/docusaurus.git synced 2025-05-05 05:07:14 +02:00

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	feat(v2): allow easy css override with custom css (#1559 )	2019-06-04 10:03:11 -07:00
docs	docs(v2): revise "writing docs" (#1561 )	2019-06-05 13:45:40 -07:00
pages	fix(v2): use infima from npm instead of trunk CDN (#1556 )	2019-06-04 00:46:31 -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	feat(v2): allow easy css override with custom css (#1559 )	2019-06-04 10:03:11 -07:00
package.json	chore(v2): add sensible default browserlist (#1542 )	2019-06-02 10:43:39 -07:00
README.md	docs(v2): add docs skeleton and structure (#1412 )	2019-04-28 20:20:24 -07:00
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