Code Monkey home page Code Monkey logo

znote's Introduction

znote

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

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

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

  • 推荐访问: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, ...

znote's People

Contributors

dependabot[bot] avatar github-actions[bot] avatar zpj80231 avatar zscnb avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

znote's Issues

Deploying issue

I'm trying to deploy this website using netlify. The build command that I used was - vuepress build docs and publish directory - docs/.vuepress/dist. According to the logs, everything seems to be fine, and it also gets built. Although, when I click on the link, the desired output is far from what gets built.
What gets built: image
The url of the deployed website: https://blissful-jennings-dfa804.netlify.app
I tried running it locally, there seems to be no problem there at all.
After running locally: Screenshot 2021-01-16 at 12 45 28 AM

Should I use some other command for deploying it? Or, is there something else that I'm missing?
Link to my repository: https://github.com/ananditavishnoi/my-blogsite

真大佬

最简洁美观的博客,非常nick~

后台管理

想folk一下,当成自己博客的模块,请问一下后台管理有吗

大佬,小彩蛋是真好看

亲爱的作者大大,
那个Love的页面特别好看
我拿去改改,送给我女朋友啦
不要介意

嘻嘻嘻
mua~😘️

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.