新建站点 [new-site]

用户在安装后可以通过执行 kodama -V 或 kodama --version 以检查是否安装成功.

要创建一个新的 kodama 风格站点, 请执行

kodama new site <PATH>

用户可以在此目录的 trees/ 文件夹下进行 Markdown 或 Typst 写作.

首次使用 serve 功能前, 用户应该检查配置文件中 [serve] 字典的 command 键, 默认值调用了 miniserve 程序, 因此用户可以选择安装 miniserve 或者将其修改为其他可用的本地服务器. 如安装了 python 的用户可以将其替换为

command = ["python", "-m", "http.server", "-d", "<output>"]

References

配置文件 [config]

参考

配置文件 Kodama.toml 目前可通过 kodama new c 单独创建, 或者在新建 Kodama 站点时自动生成. 配置文件通常包含以下内容:

[kodama]
trees = "trees" 
assets = "assets"
base-url = "/"

[build]
typst-root = "./"
short-slug = false
pretty-urls = false
footer-mode = "link"
inline-css = false
output = "./publish"

[serve]
edit = "vscode://file/"
output = "./.cache/publish"
command = ["miniserve", "<output>", "--index", "index.html", "--pretty-urls", "--port", "8082"]

`[kodama]`

trees 用于指定文档目录, 即 index.md 等文件所在的文件夹.
assets 用于指定资源目录, 如图片、字体等文件. assets 会在每次构建时自动同步到 publish/<assets>.
base-url 用于指定部署到的域名根路径.

`[build]`

typst-root 用于指定 Typst 构建时的根路径, 见 project root.
short-slug 开启后网页中每个节的 slug 只展示最后一部分.
pretty-urls 开启后网页中每个内部链接将去除 .html 后缀.
footer-mode 用于指定节的页脚部分是否嵌入关联或被关联节的正文. 值只能是 link 或 embed.
inline-css 开启后将内联 main.css 等 CSS 文件.
output 用于指定 build 模式下的网站输出路径.

`[serve]`

edit 用于指定 serve 模式下用于跳转到编辑器的 url 前缀.
output 用于指定 serve 模式下的网站输出路径.
command 用于指定 serve 时开启本地服务器的指令.