以前就想弄一个笔记库,现在用quartz来弄一个笔记库.
这是quartz的官方仓库
官方文档在https://quartz.jzhao.xyz/
你如果有耐心能看完也是挺好的
我们开始吧
条件
1.github账号
2.cloudflare账号
先去quartz仓库
点击fork分叉或者Use this template使用此模板都行(fork能保留git提交记录)
fork:Repository name(仓库名)随便,Description(介绍)随便,取消勾选Copy the main branch only(仅复制主分支),点击Create fork(创建fork ).
Use this template:Create a new repository(创建新仓库)和Open in a codespace(在代码空间中打开)
安装node.js
访问node.js
下载Windows 安装程序(.msi)
在命令行执行以下命令
git clone <你新仓库的url>
cd <你新仓库的仓库名>
npm i
npx quartz create创作内容
在仓库的content文件夹创建md文件(把obsidian的笔记仓库的笔记复杂过来)
Quartz 使用 Markdown 文件作为主要的内容编写方式,因此它完全支持 Markdown 语法。默认情况下,Quartz 还附带一些语法扩展,例如GitHub Flavored Markdown(脚注、删除线、表格、任务列表)和Obsidian Flavored Markdown(标注、维基链接)。
此外,Quartz 还允许您在笔记中指定额外的元数据,称为frontmatter。
---title: 标题//:的后面要留一个空格draft: false //是否发布页面tags: - 标签---正文Quartz 原生支持的一些常见 frontmatter 字段:
---title: 页面标题。如果未提供,Quartz 将使用文件名作为标题。description: 用于链接预览的页面描述。permalink: 页面的自定义 URL,即使文件路径发生变化,该 URL 也将保持不变。aliases: 本笔记的其他名称。这是字符串列表。tags: 此笔记的标签。draft: 是否发布页面。这是在 Quartz 中将页面设为私有的一种方法。date: 表示笔记发布日期的字符串。通常使用YYYY-MM-DD格式。---Quartz 原生支持的一些常见 frontmatter 字段:
请参阅Frontmatter以获取完整的前言列表。
编辑quartz.config.ts
编辑quartz.config.ts或更改布局文件来完成quartz.layout.ts。
import { QuartzConfig } from "./quartz/cfg"import * as Plugin from "./quartz/plugins"
/** * Quartz 4 Configuration * * See https://quartz.jzhao.xyz/configuration for more information. */const config: QuartzConfig = { configuration: { pageTitle: "Quartz 4",//网站标题。这也用于为你的网站生成 RSS 订阅源 pageTitleSuffix: "",//附加在页面标题末尾的字符串。这只适用于浏览器标签页的标题,不适用于页面顶部显示的标题 enableSPA: true,//是否在您的站点启用 SPA 路由 enablePopovers: true,//是否在您的网站上启用弹出预览 analytics: {//网站分析应使用什么。值可以为 provider: "plausible",//参考https://quartz.jzhao.xyz/configuration }, locale: "en-US",//用于 i18N 和日期格式,zh-CN baseUrl: "quartz.jzhao.xyz",你网站部署的 URL(例如 quartz.jzhao.xyz)。不包括协议(即 https://)或任何前后斜线 ignorePatterns: ["private", "templates", ".obsidian"],//一份 glob 图案列表,Quartz 在查找内容文件夹内的文件时应忽略这些,不要搜索这些 defaultDateType: "modified",//使用创建、修改或已发布作为页面和页面列表显示的默认日期 theme: {//配置网站外观 fontOrigin: "googleFonts", cdnCaching: true,//如果是( 默认),使用 Google CDN 来缓存字体。这通常会更快。如果你想让 Quartz 下载字体实现自成一体,请禁用( false )这个功能 typography: {//使用哪些字体。Google Fonts 上的任何字体都可以使用。 header: "Schibsted Grotesk",//用于标题的字体 body: "Source Sans Pro",//正文 code: "IBM Plex Mono",//用于内联和块引号的字体 },
...创建index.md
在content下创建index.md
就是主页
本地预览
在命令行执行以下命令
npx quartz build --serve打开浏览器访问 预览页面
上传
在命令行执行以下命令
git config --global user.name "你的Github用户名"git config --global user.email "你的Github邮箱@example.com"提交所有文件
git add .让我们发布一个本地提交
git commit -m "项目初始化"让我们将本地更改提交到远程仓库
git push部署
我就使用大善人cloudflare了
左侧侧边栏选择Compute(计算),Workers 和 Pages
选择创建应用程序,想要部署 Pages?后的开始使用,导入现有 Git 存储库
选择你的github仓库(我的github被标记了,只能选择gitlab仓库😭😭😭)
提供以下信息
- 生产分支 v4
- 框架预设 无
- 构建命令 npx quartz build
- 构建输出目录 public
绑定自定义域,访问自定义域即可访问你的博客!
之后只需要写文章推送至github就行,大善人会帮你自动构建