zpj80231 / znote

🎈VuePress 静态布局 Blog,清新+ 简洁+。
https://zpj80231.github.io/znote/
MIT License
164 stars 87 forks source link
blog note static-site vue vuepress znote

znote


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

项目介绍

项目运行

项目架构

## 需要自己写主题样式的话,在.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 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 -->之前的内容会展示为文章摘要

参考示例

---
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, ...