-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #35 from Roll20/Readme
Create README.md
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
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 @@ | ||
|
||
## Install dependencies | ||
In the root folder and install the dependencies before continuing. | ||
|
||
``` | ||
npm install | ||
``` | ||
|
||
## Start the development server | ||
To preview your work locally and automatically refreshes your browser when you make changes. | ||
|
||
Inside your project folder, run the following command to start the development server: | ||
|
||
``` | ||
npm run dev | ||
``` | ||
|
||
## Add pages | ||
Add new pages to your site by creating .md or .html files in content/docs/. Use sub-folders to organize your files and to create multiple path segments. | ||
|
||
For example, the following command will generate a page at example.com/docs/guides/faq: | ||
|
||
``` | ||
npm run create docs/guides/faq.md | ||
``` | ||
|
||
## Build project | ||
To build your project, run the following command: | ||
|
||
``` | ||
hugo | ||
``` | ||
|
||
Or | ||
|
||
``` | ||
npm run build | ||
``` |