-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
11 changed files
with
186 additions
and
192 deletions.
There are no files selected for viewing
25 changes: 25 additions & 0 deletions
25
packages/docusaurus-init/templates/classic/docs/create-a-blog-post.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Create a Blog Post | ||
--- | ||
|
||
This page will help you on how to create blog posts in Docusaurus. | ||
|
||
## Create a Blog Post | ||
|
||
Create a file at `blog/2021-02-28-greetings.md`: | ||
|
||
```md title="blog/2021-02-28-greetings.md" | ||
--- | ||
title: Greetings! | ||
author: Steven Hansel | ||
author_title: Docusaurus Contributor | ||
author_url: https://github.com/ShinteiMai | ||
author_image_url: https://github.com/ShinteiMai.png | ||
--- | ||
|
||
Congratulations, you have made your first post! | ||
|
||
Feel free to play around and edit this post as much you like. | ||
``` | ||
|
||
A new blog post is now available at `http://localhost:3000/blog/greetings`. |
57 changes: 0 additions & 57 deletions
57
packages/docusaurus-init/templates/classic/docs/create-a-doc.md
This file was deleted.
Oops, something went wrong.
38 changes: 38 additions & 0 deletions
38
packages/docusaurus-init/templates/classic/docs/create-a-document.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: Create a Document | ||
--- | ||
|
||
Documents are pages with a **sidebar**, a **previous/next navigation** and many other useful features. | ||
|
||
## Create a Document | ||
|
||
Create a markdown file at `docs/my-doc.md`: | ||
|
||
```mdx title="docs/hello.md" | ||
--- | ||
title: Hello, World! | ||
--- | ||
|
||
## Hello, World! | ||
|
||
This is your first document in **Docusaurus**, Congratulations! | ||
``` | ||
|
||
A new document is now available at `http://localhost:3000/docs/hello`. | ||
|
||
## Add your document to the sidebar | ||
|
||
Add `hello` to the `sidebars.js` file: | ||
|
||
```diff title="sidebars.js" | ||
module.exports = { | ||
docs: [ | ||
{ | ||
type: 'category', | ||
label: 'Docusaurus Tutorial', | ||
- items: ['getting-started', 'create-a-doc', ...], | ||
+ items: ['getting-started', 'create-a-doc', 'hello', ...], | ||
}, | ||
], | ||
}; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 0 additions & 31 deletions
31
packages/docusaurus-init/templates/classic/docs/create-a-post.md
This file was deleted.
Oops, something went wrong.
20 changes: 9 additions & 11 deletions
20
packages/docusaurus-init/templates/classic/docs/getting-started.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,28 @@ | ||
--- | ||
title: Getting Started | ||
title: Getting Started | ||
slug: / | ||
--- | ||
|
||
## Setting up the development environment | ||
|
||
### Step 1: Generate a Docusaurus site | ||
## Step 1: Generate a new Docusaurus site | ||
|
||
If you haven't already, generate a new Docusaurus site using the classic template: | ||
|
||
```shell | ||
npx @docusaurus/init@latest init my-documentation classic | ||
npx @docusaurus/init@latest init my-website classic | ||
``` | ||
|
||
### Step 2: Start your Docusaurus site | ||
## Step 2: Start your Docusaurus site | ||
|
||
Run the development server: | ||
Run the development server in the newly created `my-website` folder: | ||
|
||
```shell | ||
cd my-website | ||
|
||
npx docusaurus start | ||
``` | ||
|
||
Open `docs/getting-started.md` and edit some lines. The site should reload automatically and display your changes. | ||
Open `docs/getting-started.md` and edit some lines. The site reloads automatically and display your changes. | ||
|
||
### That's it! | ||
## That's it! | ||
|
||
Congratulations! You've successfully run and modified your Docusaurus project. | ||
|
||
|
27 changes: 0 additions & 27 deletions
27
packages/docusaurus-init/templates/classic/docs/interactiveDoc.mdx
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.