3 Star 26 Fork 20

zpj80231 / znote

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
readme.md 5.23 KB
一键复制 编辑 原始数据 按行查看 历史
zpj80231 提交于 2023-01-06 14:49 . docs: update README

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, ...
HTML
1
https://gitee.com/zpj80231/znote.git
git@gitee.com:zpj80231/znote.git
zpj80231
znote
znote
master

搜索帮助