Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit 259c308

Browse files
committed
docs: add examples section to getting-started
1 parent 70d02c9 commit 259c308

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/guide/getting-started.md

+16
Original file line numberDiff line numberDiff line change
@@ -460,6 +460,22 @@ In your theme, You'll probably offer users options whether to enable or not. You
460460

461461
Please head [UI-customization](https://vuepress-plugin-mailchimp.billyyyyy3320.com/#ui-customization) if you don't like the default UI.
462462

463+
## Examples
464+
465+
There're some [examples](https://github.com/vuepressjs/vuepress-plugin-blog/tree/master/examples) under this project help us test this plugin. They're also simplest examples for you after reading all the concept above.
466+
467+
Clone [this repo](https://github.com/vuepressjs/vuepress-plugin-blog) and start the example to see the output:
468+
```shell
469+
yarn dev:example # serves example
470+
yarn build:example # builds example
471+
```
472+
473+
:::tip Tip
474+
It's worth telling that [the `zh` folder](https://github.com/vuepressjs/vuepress-plugin-blog/tree/master/examples/zh) is an example to build the blog in your native language. It took Traditional Chinese for example.
475+
:::
476+
477+
478+
463479
## Writing a blog theme
464480

465481
If everything is ok, you can start to write a blog theme. Actually, there are only 2 necessary layout components to

0 commit comments

Comments
 (0)