zpj80231 / znote

🎈VuePress 静态布局 Blog,清新+ 简洁+。

Home Page:https://zpj80231.github.io/znote/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

znote

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

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

  • 已全局适配 手机模式暗黑模式(iOS自适应) 请自行体验

  • 推荐访问:https://zpj80231.github.io/znote/
    国内访问:https://zpj80231.gitee.io/znote/ (自Gitee实名认证后已不再同步更新,现在访问还是之前的旧版本)

  • 说明:音乐播放器插件目前在外网环境下可以正常使用(使用的网易云API) 验证播放器是否可用:能打开这个网站即可正常使用 --> 点击测试

    因为依赖项目 NeteaseCloudMusicApi 使用 Vercel 免费部署。而 Vercel 目前对国内网络不开放,所以要么自行搭建 NeteaseCloudMusicApi,要么使用魔法。

  • 本仓库代码使用 MIT 协议进行开源,但是全部文档内容使用 CC 4.0 BY-SA 协议进行发布

项目介绍

  • 记录生产级别问题排查处理(工作经验)
  • 技术栈知识点笔记总结(知识小结)
  • 个人牢*发布(生活随笔)
  • 其它(欢迎入队)...

项目运行

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

  • 在项目文件夹下执行命令运行项目:

    node14 版本:npm run dev

    node16 版本及以上:npm run dev:node:16 ,在 Mac 上运行:npm run dev:node:16: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 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, ...

About

🎈VuePress 静态布局 Blog,清新+ 简洁+。

https://zpj80231.github.io/znote/

License:MIT License


Languages

Language:Shell 100.0%