{"id":20705877,"url":"https://github.com/sun-zhenxing/vuepress-solid-template","last_synced_at":"2026-02-16T11:09:13.580Z","repository":{"id":130805695,"uuid":"567181769","full_name":"Sun-ZhenXing/vuepress-solid-template","owner":"Sun-ZhenXing","description":"Solid: a VuePress 2 Template","archived":false,"fork":false,"pushed_at":"2025-10-13T21:08:30.000Z","size":22909,"stargazers_count":3,"open_issues_count":5,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-14T19:14:03.515Z","etag":null,"topics":["docs","github-pages","pnpm","typescript","vite5","vuepress","vuepress2"],"latest_commit_sha":null,"homepage":"https://blog.alexsun.top/vuepress-solid-template/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Sun-ZhenXing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-11-17T08:45:54.000Z","updated_at":"2025-09-16T03:45:56.000Z","dependencies_parsed_at":"2023-12-10T08:23:36.289Z","dependency_job_id":"18477053-7528-42ef-9149-caa5419805fc","html_url":"https://github.com/Sun-ZhenXing/vuepress-solid-template","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/Sun-ZhenXing/vuepress-solid-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sun-ZhenXing%2Fvuepress-solid-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sun-ZhenXing%2Fvuepress-solid-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sun-ZhenXing%2Fvuepress-solid-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sun-ZhenXing%2Fvuepress-solid-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Sun-ZhenXing","download_url":"https://codeload.github.com/Sun-ZhenXing/vuepress-solid-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Sun-ZhenXing%2Fvuepress-solid-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29506441,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T09:05:14.864Z","status":"ssl_error","status_checked_at":"2026-02-16T08:55:59.364Z","response_time":115,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","github-pages","pnpm","typescript","vite5","vuepress","vuepress2"],"created_at":"2024-11-17T01:20:04.584Z","updated_at":"2026-02-16T11:09:13.559Z","avatar_url":"https://github.com/Sun-ZhenXing.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# *Solid*: a VuePress 2 Template\n\n![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/Sun-ZhenXing/vuepress-solid-template/deploy-docs.yml?branch=main)\n\n🌐 [**中文文档**](./README.zh.md) | 🚀 [**Demo Page**](https://blog.alexsun.top/vuepress-solid-template/)\n\n## *Solid* is not *Solid.js*! *Solid* is a VuePress2-powered static site generator\n\nBest VuePress2 Template. Get a beautiful and configured default theme document in a minute.\n\nFeatures:\n\n- 🎉 VuePress 2 (Vue 3 + Vite 5 + TypeScript)\n- ✨ [VuePress MarkDown Enhance](https://vuepress-theme-hope.github.io/v2/md-enhance/)\n  - 📖 Support LaTeX math formulas (use [KaTeX](https://katex.org/))\n  - 📈 [Mermaid](https://theme-hope.vuejs.press/guide/markdown/mermaid.html) (**optional**, installed by default)\n  - 📊 [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/))\n- 📋 Copy code support\n- 📜 Auto catalog generation\n- 🔍 Static search support\n- 🎇 Auto format\n\n## 1. Start\n\n```bash\ngit clone https://github.com/Sun-ZhenXing/vuepress-solid-template\ncd vuepress-solid-template\npnpm i\npnpm dev\n```\n\nThe only thing you need to do is to configure `docs/.vuepress/config.ts`:\n\n1. change `USER_NAME` to yours.\n2. change `BASE_PATH` to your repo name.\n\n## 2. Uploading code to remote repo\n\nChange `${YOUR_REPO}` to the address of your remote repository.\n\n```bash\ncd vuepress-my-docs\nrm -rf .git \u0026\u0026 git init \u0026\u0026 git add .\ngit commit -m \"init from Sun-ZhenXing/vuepress-solid-template\"\ngit remote add origin ${YOUR_REPO}\ngit branch -M main\ngit push -u origin main\n```\n\n## 3. Build\n\nBuild with `pnpm`:\n\n```bash\npnpm i\npnpm build\n```\n\nYou can find the generated static files in `docs/.vuepress/dist`.\n\nBuild with Docker:\n\n```bash\ndocker build -t vuepress-solid-template .\ndocker run -itd -p 80:80 vuepress-solid-template\n```\n\nNow you can visit \u003chttp://localhost\u003e to see your document.\n\n## 4. How to config GitHub Pages?\n\nIf you don't want it, reomve `.github/workflows/` file.\n\nWhen 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.\n\nIf you need to open GitHub Pages:\n\n1. Open your GitHub repo page\n2. Click `Settings`\n3. Click `Actions`, then click `General`\n4. Find `Workflow permissions`, select `Read and write permissions`, save\n5. 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`\n6. Click `Pages` on the sidebar, goto `Build and deployment`\n7. Config as `Branch: gh-pages /(root)`, or force HTTPS, save\n\nIt will create **GitHub Pages** automatically.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsun-zhenxing%2Fvuepress-solid-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsun-zhenxing%2Fvuepress-solid-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsun-zhenxing%2Fvuepress-solid-template/lists"}