Skip to content

potatoone/mkone

Repository files navigation

MK ONE

静态 Markdown 站点生成器

mkone

轻量静态 Markdown 站点生成工具,无需复杂配置,快速将 Markdown 文档转换为可部署的纯静态 HTML 站点。

  • 使用 数字_ 命名前缀(如 01_指南/02_快速开始.md),自动按数字排序生成侧边栏与站点路由
  • 支持常用 Markdown 语法,提示块、代码块、标签等
  • 支持目录大纲:文档描述和时间标记
  • 使用 hljs 支持代码高亮
  • 支持主题切换、自定义字体

使用教程

建议使用 Vscode + Edge 浏览器环境

安装 Node 22 版本,项目下终端执行

# 1. 全局安装 TypeScript
npm install -g typescript

# 2. 初始化 Vite 项目
npm create vite@latest

# 3. 生成 tsconfig.json 配置文件
npx tsc --init

# 4. 安装 marked
npm install marked

# 5. 安装 marked-highlight
npm install marked-highlight

# 6. 运行开发环境
npm run dev 或 npx vite --host 0.0.0.0

# 7. 打包项目
npm run build

注意: 若使用 pages 部署,将 github actions 配置为 static

About

MKONE - Markdown 静态文档站点生成器

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors