3 Star 26 Fork 20

zpj80231 / znote

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

znote

  • 积丝成寸,积寸成尺;寸尺水已,遂成丈匹。

Read the Docs GitHub
VuePress Reco
CC4.0 BY-SA LICENSE
znote site

项目介绍

  • 记录生产级别问题排查处理(工作经验)

  • 技术栈知识点笔记总结(知识小结)

  • 个人牢骚发布(生活随笔)

  • 其它(欢迎入队)...

项目运行

  • 克隆项目,在项目文件夹下执行命令,加载依赖:npm install

  • 在项目文件夹下(node 16及以下)执行命令,运行项目:npm run dev

    Windows(node 17+)版本以上运行:npm run dev:win

    Mac(node 17+)版本以上运行:npm run dev:mac

  • 待启动成功后打开地址即可:http://localhost:8080/znote/

项目架构

  • 采用 vuepress 和 主题reco 二次构建
## 需要自己写主题样式的话,在.vuepress/ 下新建theme文件夹并按如下目录布局
Dev
├─── docs
   └── .vuepress   // 配置目录
       ├── public // 静态资源
       ├── theme  // 主题
          ├── components // 组件
          ├── global-components // 全局组件
          ├── layouts // 布局(包括首页在内)
          ├── styles  // 样式
          ├── util 	 // 工具
          ├── index.js // 入口配置
          ├── noopModule.js // 依赖注入
          ├── package.json  // 主题依赖
          ├── README.md     // 主题说明
       └── config.js
   ├── about   // 项目模块
   ├── other   // 项目模块
   ├── views   // 项目模块
   └── README.md   // 首页
└── package.json //项目依赖

如何使用

对准备发布的文章(Markdown 格式),放置在项目docs/views/目录下,并在 Markdown 文件头部添加以下元素,项目发布后会自动识别文章标题、标签、分类、是否开启评论、是否加密、是否置顶、是否发布等一系列状态。

下面是关键字说明及参考示例:

  1. 关键字说明
序号 关键字 注释
1 title 文章标题
2 date 日期,如:2020-02-02
3 tags 标签
4 categories 分类
5 keys 文章加密密码
6 sticky 文章置顶 1, 2, 3, ...
7 isShowComments 是否开启评论
8 publish 文章是否发布
9 <Boxx/> 只需引入这个标签即可,随机展示名人名言
10 [[toc]] 生成目录及链接
11 <!-- more --> <!-- more -->之前的内容会展示为文章摘要
  1. 参考示例:
---
title: 文章标题
date: 2020-02-02
tags:
 - 标签
categories:
 - 分类
keys:
 - '123456'
sticky: 1 
isShowComments: false
publish: true
---

<Boxx/>

[[toc]]

- 这里可以写`摘要`等其它

<!-- more -->

## 正式开始你的markdown

- To be or not to be, ...
MIT License Copyright (c) 2019 zpj80231 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

类Vue.js官网布局的Blog,知识点复习,技术栈小结,个人牢骚发布,其它。。 展开 收起
HTML
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
HTML
1
https://gitee.com/zpj80231/znote.git
git@gitee.com:zpj80231/znote.git
zpj80231
znote
znote
master

搜索帮助

14c37bed 8189591 565d56ea 8189591