Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sun-zhenxing/vuepress-solid-template
Solid: a VuePress 2 Template
https://github.com/sun-zhenxing/vuepress-solid-template
docs github-pages pnpm typescript vite5 vuepress vuepress2
Last synced: 2 days ago
JSON representation
Solid: a VuePress 2 Template
- Host: GitHub
- URL: https://github.com/sun-zhenxing/vuepress-solid-template
- Owner: Sun-ZhenXing
- Created: 2022-11-17T08:45:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T02:26:00.000Z (28 days ago)
- Last Synced: 2024-10-23T03:36:02.005Z (27 days ago)
- Topics: docs, github-pages, pnpm, typescript, vite5, vuepress, vuepress2
- Language: Dockerfile
- Homepage: https://blog.alexsun.top/vuepress-solid-template/
- Size: 19.2 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# *Solid*: a VuePress 2 Template
π [**δΈζζζ‘£**](./README.zh.md) | π [**Demo Page**](https://blog.alexsun.top/vuepress-solid-template/)
## *Solid* is not *Solid.js*! *Solid* is a VuePress2-powered static site generator
Best VuePress2 Template. Get a beautiful and configured default theme document in a minute.
Features:
- π VuePress 2 (Vue 3 + Vite 5 + TypeScript)
- β¨ [VuePress MarkDown Enhance](https://vuepress-theme-hope.github.io/v2/md-enhance/)
- π Support LaTeX math formulas (use [KaTeX](https://katex.org/))
- π [Mermaid](https://theme-hope.vuejs.press/guide/markdown/mermaid.html) (**optional**, installed by default)
- π‘ [chartjs](https://vuepress-theme-hope.github.io/v2/md-enhance/guide/chart/chartjs.html) (**optional**, please refer to the [VuePress MarkDown Enhance](https://vuepress-theme-hope.github.io/v2/md-enhance/))
- π [Echarts](https://theme-hope.vuejs.press/guide/markdown/echarts.html) (**optional**, please refer to the [VuePress MarkDown Enhance](https://vuepress-theme-hope.github.io/v2/md-enhance/))
- ποΈ [Presentation](https://theme-hope.vuejs.press/guide/markdown/revealjs.html) (use `reveal.js`, **optional**, please refer to the [VuePress MarkDown Enhance](https://vuepress-theme-hope.github.io/v2/md-enhance/))
- π [Flowchart](https://theme-hope.vuejs.press/guide/markdown/flowchart.html) (**optional**, please refer to the [VuePress MarkDown Enhance](https://vuepress-theme-hope.github.io/v2/md-enhance/))
- π Copy code support
- π Auto catalog generation
- π Static search support
- π Auto format
## 1. Start
```bash
git clone https://github.com/Sun-ZhenXing/vuepress-solid-template
cd vuepress-solid-template
pnpm i
pnpm dev
```
The only thing you need to do is to configure `docs/.vuepress/config.ts`:
1. change `USER_NAME` to yours.
2. change `BASE_PATH` to your repo name.
## 2. Uploading code to remote repo
Change `${YOUR_REPO}` to the address of your remote repository.
```bash
cd vuepress-my-docs
rm -rf .git && git init && git add .
git commit -m "init from Sun-ZhenXing/vuepress-solid-template"
git remote add origin ${YOUR_REPO}
git branch -M main
git push -u origin main
```
## 3. Build
Build with `pnpm`:
```bash
pnpm i
pnpm build
```
You can find the generated static files in `docs/.vuepress/dist`.
Build with Docker:
```bash
docker build -t vuepress-solid-template .
docker run -itd -p 80:80 vuepress-solid-template
```
Now you can visit to see your document.
## 4. How to config GitHub Pages?
If you don't want it, reomve `.github/workflows/` file.
When building in GitHub Actions for the first time, an error will be reported and an email will be sent to you. Don't panic because you haven't set up GitHub Pages yet.
If you need to open GitHub Pages:
1. Open your GitHub repo page
2. Click `Settings`
3. Click `Actions`, then click `General`
4. Find `Workflow permissions`, select `Read and write permissions`, save
5. If you have not successfully executed GitHub Actions at this time, you need to manually execute them once. Open the actions you just created and click `re-run all jobs`
6. Click `Pages` on the sidebar, goto `Build and deployment`
7. Config as `Branch: gh-pages /(root)`, or force HTTPS, save
It will create **GitHub Pages** automatically.