15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-26 01:33:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Frank Li 2017-07-12 16:30:15 -07:00 committed by GitHub
parent ea4a4f6fe3
commit b150a94bc1
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -6,6 +6,17 @@
In your project repo, all of your documentation files should be placed inside a `docs` folder. Any blog posts should be inside a `blog` folder. Create a `website` folder inside which you will install and run docusaurus.
Example project structure:
```
project-repo/
blog/
2017-05-06-blog-post.md
docs/
en/
doc1.md
website/
```
### Installation
Inside of your `website` folder, create a `package.json` file with the following scripts for Docusaurus: