Skip to content

Commit 117f20f

Browse files
committed
add local debug section in readme.
1 parent 6acb735 commit 117f20f

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Project Aloha Website
2-
> Knowledge record for project aloha uefi and drivers developing.
2+
> Knowledge record of project aloha uefi and drivers development.
3+
4+
## Introduce
5+
Click [here](https://aloha.firmware.icu/) to jump to our document page.
36

47
## How to write and add guide here?
58
### Repo Introduce
@@ -8,6 +11,7 @@ This repo uses ***VitePress*** to generate static pages.
811
+ / -> English Guides
912
+ /zh -> Simplified Chinese Guides
1013
+ /.vitepress -> Site configure
14+
+ /.vscode -> Vscode configuration
1115

1216
### Add a page
1317
- Open .vitepress/[language].ts, like `en` or `zh`
@@ -16,7 +20,13 @@ This repo uses ***VitePress*** to generate static pages.
1620

1721
> [!TIP]
1822
> If your page needs pictures or other small resources(less than 800KB), you can put it at `[GuideClass]/Resources/[NameOfYourGuide]/`
19-
23+
24+
### Local debug
25+
- Install nodejs and insure it's added in PATH.
26+
- Clone this repo and open in vscode.
27+
- Click `Run` in vscode.
28+
Alternatively if you do not want to use vscode:
29+
- Run `npm run docs:dev` at the root of this repo.
2030

2131
### For More
2232
You can read [VitePress's Guides](https://vitepress.dev/guide/getting-started) if you want edit configurations here or want to use some speacial markdown feature provided by vitepress.

0 commit comments

Comments
 (0)