mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-28 14:08:21 +02:00
2491c53ba9
* feat(v2): improve seo - Add doc specific seo information - Add twitter meta tags to seo in theme Layout * Cannot use svg in SEO image * Add docs about SEO * add site default image for seo * Resolve PR discussion * Add `image` to config optional fields * Use theme config instead of root config for image, rename in front matter * Use absolute url for image (wont work on preview) * update docs for frontmatter field for seo * refactor * pages seo * fix * nits again' |
||
|---|---|---|
| .. | ||
| docs | ||
| src | ||
| static/img | ||
| docusaurus.config.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
Docusaurus 2 Website
Installation
yarn installin 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