# doc **Repository Path**: wayne05/doc ## Basic Information - **Project Name**: doc - **Description**: VuePress静态博客 - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-08-24 - **Last Updated**: 2021-05-07 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README 项目改自 `zpj80231` 感谢! [zpj80231](https://github.com/zpj80231/znote) ## 项目运行 - 在项目文件夹下执行命令,加载依赖:`npm install` - 在项目文件夹下执行命令,运行项目:`npm run docs:dev` - 待启动成功后打开地址即可:[http://localhost:8080/doc/](http://localhost:8080/doc/) ## 项目架构 - 采用vuepress构建 ```lua ##需要自己写主题样式的话,在.vuepress/ 下新建theme文件夹并按如下目录布局 Dev ├─── docs │ └── .vuepress // 配置目录 │ │ ├── public // 静态资源 │ │ ├── theme // 主题 │ │ │ ├── components // 组件 │ │ │ ├── global-components // 全局组件 │ │ │ ├── layouts // 布局(包括首页在内) │ │ │ ├── styles // 样式 │ │ │ ├── util // 工具 │ │ │ ├── index.js // 入口配置 │ │ │ ├── noopModule.js // 依赖注入 │ │ │ ├── package.json // 主题依赖 │ │ │ ├── README.md // 主题说明 │ │ └── config.js │ ├── about // 项目模块 │ ├── views // 项目模块 │ └── README.md // 首页 └── package.json //项目依赖 ``` ## 项目介绍 - 知识点复习和面试总结(不断完善中,欢迎加入!) - 技术栈知识点笔记总结(知识小结) - 个人牢骚发布点(生活随笔) - 其它... ## 开始编写markdown - 参考示例: ```yaml --- title: 文章标题 date: 2020-02-02 tags: - 标签 categories: - 分类 keys: - '123456' //文章加密密码 sticky: 1 //文章置顶 1, 2, 3, ... isShowComments: false //是否开启评论 publish: true //文章是否发布 --- //随机展示名人名言 [[toc]] //目录链接 - 这里可以写`摘要`等其它 //在之前的内容会展示为文章摘要 ## 正式开始你的markdown - I am the text... ```