{"id":16978390,"url":"https://github.com/rain120/vuepress-docs-template","last_synced_at":"2026-07-02T09:31:38.979Z","repository":{"id":40289219,"uuid":"243470277","full_name":"Rain120/vuepress-docs-template","owner":"Rain120","description":"vuepress docs template","archived":false,"fork":false,"pushed_at":"2023-03-02T19:11:27.000Z","size":2228,"stargazers_count":0,"open_issues_count":8,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-11-09T23:26:56.184Z","etag":null,"topics":["docs","docs-template","template","vuepress","vuepress-blog","vuepress-docs","vuepress-docs-template"],"latest_commit_sha":null,"homepage":"https://rain120.github.io/vuepress-docs-template/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Rain120.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2020-02-27T08:36:10.000Z","updated_at":"2023-01-31T17:56:36.000Z","dependencies_parsed_at":"2025-06-30T11:03:16.279Z","dependency_job_id":"35f50c5a-1484-4d78-ab79-93646fbaaef5","html_url":"https://github.com/Rain120/vuepress-docs-template","commit_stats":null,"previous_names":[],"tags_count":1,"template":true,"template_full_name":null,"purl":"pkg:github/Rain120/vuepress-docs-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rain120%2Fvuepress-docs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rain120%2Fvuepress-docs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rain120%2Fvuepress-docs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rain120%2Fvuepress-docs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Rain120","download_url":"https://codeload.github.com/Rain120/vuepress-docs-template/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Rain120%2Fvuepress-docs-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35041996,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-02T02:00:06.368Z","response_time":173,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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","docs-template","template","vuepress","vuepress-blog","vuepress-docs","vuepress-docs-template"],"created_at":"2024-10-14T01:43:16.907Z","updated_at":"2026-07-02T09:31:38.957Z","avatar_url":"https://github.com/Rain120.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch3 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Rain120/vuepress-docs-template\"\u003eVuepress Docs Template\u003c/a\u003e\n  \u003cimg align=\"center\" src=\"docs/.vuepress/public/images/docs.png\" /\u003e\n\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n[![GitHub watchers](https://img.shields.io/github/watchers/rain120/vuepress-docs-template?style=social)](https://github.com/Rain120/vuepress-docs-template/watchers)\n[![STAR](https://img.shields.io/github/stars/rain120/vuepress-docs-template?style=social)](https://github.com/Rain120/vuepress-docs-template/stargazers) [![FORK](https://img.shields.io/github/forks/rain120/vuepress-docs-template?style=social)](https://github.com/Rain120/vuepress-docs-template/network/members)\n\n[![ISSUES](https://img.shields.io/github/issues/rain120/vuepress-docs-template?style=flat-square)](https://github.com/Rain120/vuepress-docs-template/issues) [![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/rain120/vuepress-docs-template?style=flat-square)](https://github.com/Rain120/vuepress-docs-template/pulls) [![COMMIT](https://img.shields.io/github/last-commit/rain120/vuepress-docs-template?style=flat-square)](https://github.com/Rain120/vuepress-docs-template/commits/master)\n\n![LANGUAGES](https://img.shields.io/github/languages/top/rain120/vuepress-docs-template?style=flat-square)\n[![VERSION](https://img.shields.io/github/package-json/v/rain120/vuepress-docs-template?style=flat-square)](https://github.com/Rain120/vuepress-docs-template/blob/master/package.json) [![LICENSE](https://img.shields.io/github/license/rain120/vuepress-docs-template?style=flat-square)](https://github.com/Rain120/vuepress-docs-template/blob/master/LICENSE)\n\n\u003c/div\u003e\n\n## 😚 Welcome\n\nWelcome to the Vuepress Docs Template\n\n## 🎮 TL;DR\n\n⌨️ To be Continue...\n\n## ✍ Why am I doing this?\n\nEasy to write documents for someone.\n\n## 🔨 Usage\n\n### Pure Document\n\n```sh {1}\ngit clone git@github.com:Rain120/vuepress-docs-template.git\n\nyarn install # or npm install\n```\n\n**Deploy**\n\nWe are auto deploy when you are commit by the **pre-commit** of the husky hooks. So you just need to add, commit, push. Etc:\n\n```sh\ngit add .\ngit commit -m 'feat: vuepress docs template commit'\n\n# if you need to pulls\n# git pull origin master\n\ngit push origin master\n```\n\nWe can also deploy by yourself, but we also deploy it when you commit, if you want to deploy by yourself, you can modify the **pre-commit** of the husky hooks, remove the command with `npm run deploy`.\n\n```sh\nnpm run deploy\n```\n\n### Project Document\n\nLet me see our template folders.\n\n```sh\ntree . -al 3 -I \"node_modules|dist|images|.git|.DS_Store\"\n```\n\n```sh\n.\n├── .github\n│   └── ISSUE_TEMPLATE\n│       ├── bug_report.md\n│       ├── custom.md\n│       └── feature_request.md\n├── .gitignore\n├── LICENSE\n├── README.md\n├── commitlint.config.js\n├── deploy.sh # copy to your project root\n├── docs # copy to your project root\n│   ├── .vuepress\n│   │   ├── components\n│   │   │   └── MySWUpdatePopup.vue\n│   │   ├── config.js\n│   │   ├── enhanceApp.js\n│   │   ├── public\n│   │   │   ├── logo.png\n│   │   │   └── manifest.json\n│   │   ├── styles\n│   │   │   └── index.styl\n│   │   ├── theme\n│   │   └── utils\n│   │       ├── alias.json\n│   │       ├── copy.js\n│   │       ├── nav.js\n│   │       ├── plugins.js\n│   │       └── sidebarHelper.js\n│   ├── README.md\n│   └── zh\n│       ├── guide\n│       │   └── README.md\n│       ├── how-to-config-docs\n│       │   └── README.md\n│       └── how-to-write-docs\n│           └── README.md\n├── package-lock.json\n├── package.json\n├── wechat-zhifubao-pay.png\n└── yarn.lock\n3 [error opening dir]\n\n13 directories, 27 files\n```\n\nFirst copy the **docs** folder and the **deploy.sh** file to your project root, and then we need to copy something in **package.json**. Let's do it.\n\n[package](package.json)\n\nNow we had seen all things about **package.json**. We just need **devDependencies**, if you had someone of **devDependencies**, you needn't all of that.\n\n#### devDependencies\n\n```json\n{\n  \"devDependencies\": {\n    \"@vuepress/plugin-back-to-top\": \"^1.2.0\",\n    \"@vuepress/plugin-blog\": \"^1.9.2\",\n    \"@vuepress/plugin-google-analytics\": \"^1.2.0\",\n    \"@vuepress/plugin-medium-zoom\": \"^1.0.0-rc.1\",\n    \"@vuepress/plugin-pwa\": \"^1.3.0\",\n    \"conventional-changelog-cli\": \"^2.0.27\",\n    \"husky\": \"^3.0.9\",\n    \"lint-staged\": \"^9.4.3\",\n    \"markdown-it-imsize\": \"^2.0.1\",\n    \"markdown-it-katex\": \"^2.0.3\",\n    \"markdown-it-task-lists\": \"^2.1.1\",\n    \"moment\": \"^2.24.0\",\n    \"vuepress\": \"^1.3.1\",\n    \"vuepress-plugin-awesome-gitalk\": \"^0.0.4\"\n  }\n}\n```\n\nIf you don't want to format your commit and changelog, there 3 **package** you can remove it. But if you need it and you have not config it, please go to [husky](#husky)\n```json\n{\n  \"devDependencies\": {\n    \"conventional-changelog-cli\": \"^2.0.27\",\n    \"husky\": \"^3.0.9\",\n    \"lint-staged\": \"^9.4.3\"\n  }\n}\n```\n\n#### scripts\n\n```json\n{\n  \"scripts\": {\n    \"lint-staged\": \"lint-staged\",\n    \"changelog\": \"conventional-changelog -p angular -i CHANGELOG.md -s -r 0\",\n    \"docs:dev\": \"vuepress dev docs\",\n    \"docs:build\": \"vuepress build docs\",\n    \"deploy\": \"bash ./scripts/deploy.sh\",\n    \"remote\": \"bash ./scripts/add-remote.sh\"\n  }\n}\n```\n\nIf you don't want to format your commit and changelog, there 2 **scripts** you can remove it. But if you need it and you have not config it, please go to [husky](#husky)\n\n```json\n{\n  \"scripts\": {\n    \"lint-staged\": \"lint-staged\",\n    \"changelog\": \"conventional-changelog -p angular -i CHANGELOG.md -s -r 0\"\n  }\n}\n```\n\n#### husky\n\n```json {9}\n{\n  \"lint-staged\": {\n    \"{src}/**/**.ts\": [\n      \"git add\"\n    ]\n  },\n  \"husky\": {\n    \"hooks\": {\n      \"pre-commit\": \"npm run changelog \u0026\u0026 npm run deploy \u0026\u0026 git add . \u0026\u0026 lint-staged\",\n      \"commit-msg\": \"commitlint -E HUSKY_GIT_PARAMS\"\n    }\n  },\n}\n```\n\nMore Config Detail Please Goto the Links.\n\n[how-to-config-docs](docs/zh/how-to-config-docs/README.md)\n\n[how-to-write-docs](docs/zh/how-to-write-docs/README.md)\n\nNow you have all mine, Enjoy yourself!! 😉😉😉\n\n## 🤝 Contributing\n\n![PR](https://img.shields.io/badge/PRs-Welcome-orange?style=flat-square\u0026logo=appveyor)\n\nWe welcome all contributions. You can submit any ideas as [pull requests](https://github.com/Rain120/vuepress-docs-template/pulls) or as a GitHub [issue](https://github.com/Rain120/vuepress-docs-template/issues).\n\n## 🔗 Links\n\n- [Vuepress Docs](https://vuepress.vuejs.org/)\n\n- [Demo](https://rain120.github.io/vuepress-docs-template)\n\n- [awesome-javascript-code-implementation github.io](https://rain120.github.io/awesome-javascript-code-implementation/)\n\n## 👨‍🏭 Author\n\n\u003e Front-End development engineer, technology stack: React + Typescript + Mobx, also used Vue + Vuex for a while\n\n- [Github](https://github.com/Rain120)\n- [知乎](https://www.zhihu.com/people/yan-yang-nian-hua-120/activities)\n- [掘金](https://juejin.im/user/57c616496be3ff00584f54db)\n\n## 📝 License\n\n[MIT](https://github.com/Rain120/vuepress-docs-template/blob/master/LICENSE)\n\nCopyright © 2020-present [Rain120](https://github.com/Rain120).\n\n## ☕ Coffee or Tea\n\n![wechat-zhifubao-pay.png](./wechat-zhifubao-pay.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frain120%2Fvuepress-docs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frain120%2Fvuepress-docs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frain120%2Fvuepress-docs-template/lists"}