Skip to content

Commit 2168792

Browse files
authored
[ci skip] Update README.md
1 parent 078d8d6 commit 2168792

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,23 +13,24 @@ in [scrapiyard](https://github.com/ProjectIgnis/scrapiyard).
1313

1414
## Contribute
1515

16-
Every page in the site has an "Edit" Link which will open the corresponding
16+
Every page in the site has an "Edit this page" link which will open the corresponding
1717
file on github in edit mode. For now, we recommend
1818
[helping edit the API doc entries](https://github.com/ProjectIgnis/scrapiyard/blob/master/v1-nification.md)
1919
rather than the "Getting Started" and "Guides" pages.
2020

2121
## Building/Previewing Locally
2222

23-
- Clone the repos. Make sure they're in the same folder.
24-
- git clone https://github.com/ProjectIgnis/scrapiyard
25-
- git clone https://github.com/ProjectIgnis/scrapi-book
23+
- Clone the repos:
24+
- `git clone https://github.com/ProjectIgnis/scrapiyard`
25+
- `git clone https://github.com/ProjectIgnis/scrapi-book`
2626

27-
> NOTE: For now, it's important that they're in the same folder for `book` to find the doc files.
27+
> NOTE: For now, it's important that they're in the same folder for `scrapi-book` to find the doc files.
2828
> Later, there will be an option to specify the local directory or remote repo of scrapiyard.
2929
30+
- Navigate into book: `cd scrapi-book`
3031
- Install dependencies: `npm i`
3132
- Run any of the following:
3233
- `npm run book:preview` for a basic preview
3334
- `npm run book:dev` to start a dev server on `http://localhost:5173/scrapi-book/`
3435
that hot-reloads when files are edited (this does not include editing the yaml files in scrapiyard).
35-
- `npm run book:build` to create all the website files. They will be under `/docs/.vitepress/dist`.
36+
- `npm run book:build` to generate all the website files. This will take more time than `preview` or `dev`. The output will be under `/docs/.vitepress/dist`.

0 commit comments

Comments
 (0)