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

History

Endi 2d6aaea069 feat(v2): allow custom syntax highlighting theme (#1674 )		2019-07-18 11:19:00 -07:00
..
docs	feat(v2): allow custom syntax highlighting theme (#1674 )	2019-07-18 11:19:00 -07:00
src	chore(v2): fix landing page avatar (#1675 )	2019-07-19 00:12:18 +07:00
static/img	feat(v2): optimize image processing with sharp & lqip (#1663 )	2019-07-14 11:28:16 -07:00
docusaurus.config.js	chore(v2): fix landing page avatar (#1675 )	2019-07-19 00:12:18 +07:00
package.json	feat(v2): @docusaurus/plugin-ideal-image (#1665 )	2019-07-17 21:53:40 +08:00
README.md	docs(v2): add docs skeleton and structure (#1412 )	2019-04-28 20:20:24 -07:00
sidebars.js	docs(v2): proofread docs for alpha.20 (#1658 )	2019-07-13 19:21:39 -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