首页
/ 我的第一个Quarkdown文档

我的第一个Quarkdown文档

2026-05-03 10:12:11作者:申梦珏Efrain

这是一个使用Quarkdown创建的示例文档。

特性展示

  • 支持复杂排版
  • 函数编程能力
  • 学术引用和参考文献

### 编译文档

使用以下命令编译你的Quarkdown文档:

```bash
# 基本编译
quarkdown compile document.qd

# 带实时预览的编译
quarkdown compile document.qd --preview --watch

Quarkdown有哪些实用功能值得一试?

Quarkdown提供了丰富的功能来满足各种排版需求:

  • 实时预览:使用--preview选项在浏览器中实时查看文档效果
  • PDF导出:添加--pdf参数生成高质量PDF文件
  • 自定义输出目录:使用--output <目录>指定输出位置
  • 多格式渲染:支持htmlhtml-pdf等多种渲染器

Quarkdown文档示例效果

如何解决Quarkdown使用过程中的常见问题?

问题1:安装后命令无法识别

解决方案:确保Quarkdown的安装路径已添加到系统的PATH环境变量中。

# 临时添加(当前终端会话)
export PATH=$PATH:/opt/quarkdown/bin

# 永久添加(根据你的shell配置文件选择)
echo 'export PATH=$PATH:/opt/quarkdown/bin' >> ~/.bashrc
# 或
echo 'export PATH=$PATH:/opt/quarkdown/bin' >> ~/.zshrc

问题2:PDF导出失败

解决方案:确保Node.js和npm已正确安装,然后重新安装Puppeteer:

# 安装或更新Puppeteer
npm install -g puppeteer

问题3:中文显示乱码

解决方案:在文档开头添加字体配置:

@font {
  family: "Noto Sans", "Noto Serif", "Noto Sans CJK SC";
}

Quarkdown高级技巧:让你的文档更上一层楼

技巧1:使用函数实现动态内容

Quarkdown支持函数调用,可以创建动态内容:

# 自动生成的目录
${document.toc(depth=3)}

# 当前日期
${date.now(format="yyyy-MM-dd")}

技巧2:自定义CSS样式

通过@style块自定义文档样式:

@style {
  .custom-box {
    background-color: #f5f5f5;
    border-left: 4px solid #3498db;
    padding: 1rem;
    margin: 1rem 0;
  }
}

::: custom-box
这是一个自定义样式的内容块
:::
登录后查看全文
热门项目推荐
相关项目推荐