目前, 用户可以根据目标设备的架构直接从 GitHub Release 页面下载二进制文件. 当 GitHub Release 页面缺少适合你设备的文件时, 你可以从 源代码 开始自己构建, 如

cargo install --git https://github.com/kokic/kodama.git

如果希望在 Termux 等 Android 环境中使用, 请下载 aarch64-unknown-linux-musl, 或 克隆 源代码 至本地后在其目录下执行

cargo build --release --target=aarch64-unknown-linux-musl

我们建议用户使用最新版本, 即便该版本被标记为 pre-release. 由于并非所有 GitHub Release 都能第一时间发现潜在的问题, 如果用户愿意安装 Rust 工具链, 则自行构建是最推荐的安装方式. 在 1.0 版本发布前, 每次发布都可能包含破坏性变更, 不过我们会努力使迁移成本尽可能降低.

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

要创建一个新的 Kodama 站点, 请执行:

kodama new site <PATH>

用户可以在该目录的 trees/ 下进行 Markdown 或 Typst 写作.

首次使用 serve 前, 建议检查 配置文件 中 [serve] 的 command. 默认命令依赖 miniserve, 你可以安装它, 或改为当前设备可用的本地服务命令. 例如:

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

如果用户需要生成 VSCode 风格的 snippets 文件, 进而借助其 节 代码补全功能 ¹, 可在 Kodama 站点文件夹内执行

kodama snip --section

除此之外, kodama snip 也可以用于生成 $\KaTeX$ 宏补全文件和 inline-section 可用代码片段.

$ kodama snip --help

Generate VSCode style snippets file

Usage: kodama snip [OPTIONS]

Options:
  -c, --config <CONFIG>  Path to the configuration file (e.g., "Kodama.toml") [default: ./Kodama.toml]
      --katex            Generate `.vscode/katex.code-snippets`
      --section          Generate `.vscode/section.code-snippets`
      --inline-section   Generate `.vscode/inline-section.code-snippets`
  -h, --help             Print help

从 软件 的角度讲, 我们不应该要求用户以何种方式给他们的文件起名, 但确定一种灵活且规律的命名方式确实能帮助我们在给文件命名时省去不少时间.

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/obsidian.min.css">
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/xml.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/shell.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/rust.min.js"></script>

<script>
  hljs.configure({ cssSelector: 'pre code[class^="language-"]' });
  hljs.highlightAll();
</script>

<style>
  pre {
    background-color: transparent;
  }

  .hljs {
    background-color: var(--background-color-code);
  }

  .hljs,
  .hljs-subst.hljs-class .hljs-title,
  .hljs-code,
  .hljs-section,
  .hljs-title.class_ {
    color: var(--text-color);
  }
</style>