Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yangshun authored Sep 1, 2018
1 parent f52fa06 commit c78ae64
Showing 1 changed file with 25 additions and 13 deletions.
38 changes: 25 additions & 13 deletions examples/basics/README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,32 @@
This website was created with [Docusaurus](https://docusaurus.io/).

# What's In This Document

* [Get Started in 5 Minutes](#get-started-in-5-minutes)
* [Directory Structure](#directory-structure)
* [Editing Content](#editing-content)
* [Adding Content](#adding-content)
* [Full Documentation](#full-documentation)

# Get Started in 5 Minutes

1. Make sure all the dependencies for the website are installed:

```sh
# install dependencies
# Install dependencies
$ yarn
```
2. Run your dev server:

```sh
# start the site
# Start the site
$ yarn start
```

## Directory Structure

Your project file structure should look something like this

```
my-docusaurus/
docs/
Expand All @@ -45,9 +51,11 @@ my-docusaurus/
# Editing Content

## Editing an existing docs page
1) Edit docs by navigating to `docs/` and editing the corresponding document:

Edit docs by navigating to `docs/` and editing the corresponding document:

`docs/doc-to-be-edited.md`

```markdown
---
id: page-needs-edit
Expand All @@ -60,7 +68,8 @@ Edit me...
For more information about docs, click [here](https://docusaurus.io/docs/en/navigation)

## Editing an existing blog post
1) Edit blog posts by navigating to `website/blog` and editing the corresponding post:

Edit blog posts by navigating to `website/blog` and editing the corresponding post:

`website/blog/post-to-be-edited.md`
```markdown
Expand All @@ -77,10 +86,10 @@ For more information about blog posts, click [here](https://docusaurus.io/docs/e
# Adding Content

## Adding a new docs page to an existing sidebar
1. Create the doc as a new markdown file in /docs:

`docs/newly-created-doc.md`
```markdown
1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`:

```md
---
id: newly-created-doc
title: This Doc Needs To Be Edited
Expand All @@ -89,11 +98,10 @@ title: This Doc Needs To Be Edited
My new content here..
```

2. Refer to that doc's ID in an existing sidebar in website/sidebar.json:
1. Refer to that doc's ID in an existing sidebar in `website/sidebar.json`:

`website/sidebar.json`
```javascript
// add newly-created-doc to the Getting Started category of docs
// Add newly-created-doc to the Getting Started category of docs
{
"docs": {
"Getting Started": [
Expand All @@ -109,6 +117,7 @@ My new content here..
For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation)

## Adding a new blog post

1. Make sure there is a header link to your blog in `website/siteConfig.js`:

`website/siteConfig.js`
Expand All @@ -123,6 +132,7 @@ headerLinks: [
2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`:

`website/blog/2018-05-21-New-Blog-Post.md`

```markdown
---
author: Frank Li
Expand All @@ -137,6 +147,7 @@ Lorem Ipsum...
For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog)

## Adding items to your site's top navigation bar

1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`:

`website/siteConfig.js`
Expand All @@ -159,8 +170,9 @@ For more information about blog posts, click [here](https://docusaurus.io/docs/e
For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation)

## Adding custom pages

1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`:
2. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the headerLinks element:
1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element:

`website/siteConfig.js`
```javascript
Expand All @@ -174,8 +186,8 @@ For more information about the navigation bar, click [here](https://docusaurus.i
}
```

For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages)
For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages).

# Full Documentation

Full documentation can be found at the [website](https://docusaurus.io/)
Full documentation can be found on the [website](https://docusaurus.io/).

0 comments on commit c78ae64

Please sign in to comment.