Skip to content

Commit

Permalink
📄 docs: 更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
zhiyu1998 committed Aug 15, 2024
1 parent dab8417 commit cb6e5ce
Showing 1 changed file with 1 addition and 39 deletions.
40 changes: 1 addition & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1 @@
## Detail

This is a blog theme used vitepress to build. You could [click here](https://visionary-sunflower-dc7ae3.netlify.app/) to see what it looks like.

## Highlights

- [x] pagination
- [x] dark mode
- [x] archives
- [x] tags
- [x] content level
- [x] comments
- [x] lastUpdated
- [x] github actions
- [x] mobile + desktop
- [x] RSS
- [x] Local Search
- [x] Math Equation(markdown-it-mathjax3)
- [x] type information with jsdoc on code snippets (by https://shikiji.netlify.app/packages/markdown-it )

## Start

```shell
npx degit clark-cui/vitepress-blog-zaun my-vitepress-blog
cd my-vitepress-blog
pnpm i # If you didn't install pnpm,you can run: npm install -g pnpm
pnpm dev
```

If you want to view rss result or use local search in development mode, you should run

```shell
pnpm run build
pnpm run serve
```
## Announcement
Due to my busy work, I don't have a lot of time to maintain this theme, and currently it's just an usual dependency upgrade.
This theme is more suitable for developers with experience, you can fork my repository, custom modification.
For users who don't know how to code, you may encounter problems and feel uncomfortable, I'm happy to help, but if I reply to the delay please forgive me.
## R插件文档分支

0 comments on commit cb6e5ce

Please sign in to comment.