因为目前博客的主题在文字排版上总感觉有一些问题,再加上想做一个个人的知识整合网站于是就开始折腾Docusaurus。
创建项目
- 新建一个GitHub仓库,使用codespace打开。
- 在命令行中初始化docusaurus
npx create-docusaurus@latest my-knowledge-repo classic --typescript npm run start - 将文件移动到当前目录:
mv my-knowledge-repo/* . - 提交变更,初始化完成
Github Action + Github Pages
根据官方文档Triggering deployment with GitHub Actions操作。
docusaurus.config.ts
除了一些网站的基本描述配置之外还有一些值得注意的配置项:
navbar-items
上方navebar项目配置:Navbar items
代码高亮
prism: {
additionalLanguages: [
'java',
'latex',
'haskell',
'matlab',
'PHp',
'bash',
'diff',
'json',
'scss',
],
}
sidebar.ts
使用官方文档作为例子:
const sidebars: SidebarsConfig = {
technical: [
'technical/introduction',
{
label: 'Programming Language Pragmatics',
type: 'category',
link: {
type: 'generated-index',
title: 'Programming Language Pragmatics',
description:
"Programming Language Pragmatics笔记",
},
items:[
'technical/programming-language-pragmatics/01',
'technical/programming-language-pragmatics/02'
],
}
],
life: [{type: 'autogenerated', dirName: 'life'}],
};
items: [
{
label: 'Technical',
to: 'docs/technical',
},
]
MDX语法
警告:
:::note
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::tip
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::info
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::warning
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::danger
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::