HXLoLiHub
一、简介
HXLoLiHub是一款基于 Docusaurus 魔改的主题.
-
它的代码块使用的是
One-Dark-Pro主题. -
支持了嵌入
BiLiBiLi视频、力扣同款分组代码块、Monaco Editor编辑器、.drawio.svg文件预览等等.
1.1 👋 核心理念
核心理念是非侵入式编写 MarkDown 文本, 比如:
-
力扣同款分组代码块是基于```代码块语法的, 即便你日后迁移到其他平台, 它只是退化为普通的代码块, 而 不是 一些无法被支持的
Html/MDX语法. -
.drawio.svg文件预览是基于![]()图片块语法的, 即便你日后迁移到其他平台, 它只是退回为普通的图片; 并且文件还是使用.svg, 其在几乎任何平台都是支持的图片格式, 无需因为丢失.drawio.svg而烦恼(至少Draw.io还是可以编辑它们的).
1.2 ✨ 特性
- 🦖 基于 Docusaurus - 强大的文档生成和博客功能，帮助您轻松搭建和管理内容。
- ✍️ Markdown 支持 - 使用简洁易读的 Markdown 格式进行创作，让写作变得更加轻松和高效。
- 🎨 美观设计 - 以用户体验为核心，提供整洁、现代的界面，确保优雅的阅读体验。
- 🌐 国际化支持 (i18n) - 内建国际化功能，轻松支持多语言切换，让您的内容覆盖全球。
- 🚀 持续集成与自动部署 - 集成 CI/CD 流程，实现自动化更新和部署，让您的文档随时保持最新。
- 🖥️ 轻松部署到 Github Pages - 无需额外的服务器，直接将项目部署到 Github Pages，简单高效。
- 🌈 高度自定义 - 在此基础上，您可以自由“魔改”系统，灵活定制和扩展以满足您的独特需求。
二、核心功能预览
- 支持力扣同款分组代码块:
- 支持在浏览器上编辑代码(纯前端, 不会修改到本地数据, 仅相当于暂时编辑区), 以代替复制:
- 支持在浏览器上预览
.drawio.svg文件:
更多功能, 请见 MarkDown 拓展
三、使用与部署
3.1 使用
git clone https://github.com/HengXin666/HXLoLiHub.git
cd HXLoLiHub
npm i
npm run start
此时即可在本地打开 http://127.0.0.1:3000/ 预览到项目.
3.2 部署
项目已经配置了 Github 工作流 您只需要推送则会自动进行部署到 Github Page.
Tip
当然, 在此之前还需要一些配置, 详细教程请看 开始使用(部署指南).
或者在本地手动运行:
npm docusaurus deploy
也会编译然后部署到 Github Page上.
