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

History

Wei Gao e2338bd0c2 docs(v2): minor revisions on live coding docs (#1594 ) * Use relative file path in md * Need .md file extention in link * docs(v2): minor revisions on live coding block		2019-06-09 12:04:37 +08:00
..
components/BrowserWindow	fix(v2): browser window styles on smaller screen (#1586 )	2019-06-07 09:32:52 -07:00
css	feat(v2): doc page layout changes (#1580 )	2019-06-07 14:32:45 +08:00
docs	docs(v2): minor revisions on live coding docs (#1594 )	2019-06-09 12:04:37 +08: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	refactor(v2): move livecodeblock as plugin (#1566 )	2019-06-06 15:49:11 +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