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

History

Sam Zhou 75c7cffe97 docs(v2): add docs about CNAME support in deployment (#1637 ) * Update deployment.md * Update deployment.md * Update deployment.md		2019-07-05 11:18:46 -07:00
..
docs	docs(v2): add docs about CNAME support in deployment (#1637 )	2019-07-05 11:18:46 -07:00
src	refactor(v2): move source files to be under website/src directory (#1609 )	2019-06-15 09:59:23 -07:00
static/img	docs: add Bitcoin-S to users (#1635 )	2019-07-04 18:37:34 -07:00
docusaurus.config.js	refactor(v2): move source files to be under website/src directory (#1609 )	2019-06-15 09:59:23 -07:00
package.json	v2.0.0-alpha.19	2019-06-07 00:52:48 +08: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