{"id":19739793,"url":"https://github.com/bajins/notes-vuepress","last_synced_at":"2025-04-30T05:32:31.951Z","repository":{"id":39904217,"uuid":"122915107","full_name":"bajins/notes-vuepress","owner":"bajins","description":"使用VuePress构建静态网站 https://github.com/bajins/bajins.github.io ，动态构建 https://github.com/bajins/notes-docsify","archived":false,"fork":false,"pushed_at":"2025-04-25T05:28:57.000Z","size":94013,"stargazers_count":138,"open_issues_count":0,"forks_count":58,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-04-25T06:31:43.018Z","etag":null,"topics":["blog","blogging","golang","ide","java","javascript","notebook","notes","python","shell","site","site-generator","sql","system","vuepress","vuepress-blog","vuepress-site","web","website"],"latest_commit_sha":null,"homepage":"https://bajins.com","language":"HTML","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/bajins.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}},"created_at":"2018-02-26T04:53:55.000Z","updated_at":"2025-04-25T05:29:00.000Z","dependencies_parsed_at":"2023-09-23T02:27:27.251Z","dependency_job_id":"bf48ebf1-7f34-4063-a044-2b375b4dcae5","html_url":"https://github.com/bajins/notes-vuepress","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajins%2Fnotes-vuepress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajins%2Fnotes-vuepress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajins%2Fnotes-vuepress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bajins%2Fnotes-vuepress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bajins","download_url":"https://codeload.github.com/bajins/notes-vuepress/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251649529,"owners_count":21621552,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["blog","blogging","golang","ide","java","javascript","notebook","notes","python","shell","site","site-generator","sql","system","vuepress","vuepress-blog","vuepress-site","web","website"],"created_at":"2024-11-12T01:18:23.204Z","updated_at":"2025-04-30T05:32:30.381Z","avatar_url":"https://github.com/bajins.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\nhome: true\nactionText: Work-Life Balance →\nactionLink: /#命令\n---\n\n# 使用\n\n::: tip\n基于本仓库可快速创建你自己的文档网站。\n[高亮语法支持列表](https://prismjs.com/#supported-languages)\n[PrismJS](https://github.com/PrismJS)[Shiki](https://github.com/shikijs/shiki)\n:::\n::: tip\n编译时自动帮你配置菜单栏和侧边栏，最多三层目录结构。\n:::\n::: tip\n非常多的热心开发者开源主题[vuepress-theme](https://github.com/search?q=vuepress-theme)\n:::\n\n::: tip\n如果觉得使用[VuePress](https://v2.vuepress.vuejs.org)[vitepress](https://vitepress.vuejs.org)不便，\n可使用静态博客写作客户端[gridea](https://github.com/getgridea/gridea)\n:::\n\n## 目录结构\n\n* [官方标准目录结构](https://vuepress.vuejs.org/zh/guide/directory-structure.html)\n\n```\n.\n│  .gitignore           git忽略文件\n│  package-lock.json    NPM依赖配置文件\n│  yarn.lock            yarn依赖配置文件\n│  package.json         项目配置文件\n│  README.md            首页md文件\n│  \n├─.github               GitHub配置目录\n│  └─workflows          Actions工作流目录\n│          deloy.yml    项目的Actions部署配置\n│          \n├─.vuepress             用于存放VuePress的配置、组件、静态资源等。\n│  │  config.js         VuePress配置\n│  │  nav.js            除创建的目录之外，自定义添加的导航栏\n│  │  push.js           自定义推送脚本\n│  │  utils.js          侧边栏和菜单栏自动配置工具\n│  │  \n│  ├─styles             用于存放样式相关的文件\n│  │  │  \n│  │  └─index.styl      自定义全局样式文件\n│  │  \n│  ├─public             静态资源目录\n│  │  │  CNAME          CNAME文件指定域名，防止发布时被清空\n│  │  │  manifest.json  5+App（HTML5 Plus移动App）的配置文件\n│  │  │  static.json    heroku使用buildpack静态部署配置文件\n│  │  │  \n│  │  ├─assets          css/img/js等默认的存放路径\n│  │  │   │  \n│  │  │   └─js          自定义js文件存放目录\n│  │  │  \n│  │  ├─files           可直接访问并下载的文件存放目录\n│  │  │      \n│  │  └─images          存放所有文档的图片目录\n│  │      │  \n│  │      └─icons       存放图标目录\n│  │              \n│  └─theme              主题存放目录\n│              \n├─docs                  编译后的静态资源文件输出目录\n│\n│\n......其他自己的md文档或文件夹，都会打包到docs文件夹下，md文件会编译成html\n```\n**也就是你只需要遵从以上目录结构来修改你自己的文档即可使用。**\n::: warning 注意\n配置文件中的注释文字部分，请结合[VuePress官方文档](https://vuepress.vuejs.org/zh/config)一定理解其意义再修改配置！\n:::\n\n## 命令\n\n[![](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#github.com/bajins/notes-vuepress)\n\n``` bash\n# 先克隆本仓库\ngit clone https://github.com/bajins/notes-vuepress.git\n\n# 保留上面目录结构列出的文件和文件夹，其他的全部删除\n\n# 使用前请自行安装Node.js环境\n\n# 安装项目的全部依赖\nnpm install\n\n# 这时创建并书写你自己的md文档\n\n# 开始运行开发环境，然后访问窗口中的路径\nnpm run dev\n\n# 修改.vuepress/public/CNAME中的域名\n\n# 如果发布到GitHub请见：项目的Actions部署配置\n# Actions教程：https://www.bajins.com/IDE/Git%E6%9C%8D%E5%8A%A1.html#actions\n\n```\n\n::: warning 注意\n请确保你的 Node.js 版本 \u003e= 8.6。\n:::\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbajins%2Fnotes-vuepress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbajins%2Fnotes-vuepress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbajins%2Fnotes-vuepress/lists"}