wn-mitch/tikz-flora

选用指南

AI 根据 README 整理 · 2026/11/1 04:21:41

适用场景

适用于在文档页边空白生成植物装饰，可调整布局为左右边距、标题页或环绕文本，并能填充文本间隙。

查看 README 依据

`MODULES`; the gallery and the tests pick it up, and `tests/test_ornaments.lua` holds it to its box. ```latex \florasetup{layout=split, visitors=0.5, mix={lily=2, umbel=0}, palette={hero=murasaki-shikibu, blooms=warm, leaves=teal}} ``` ### Layouts - `left`: the left margin (the default). - `right`: the right margin. - `centered`: both side margins, with two different plants. - `split`: the outer margin of a two-sided document. It is on the right of odd pages and the left of even ones. - `title`: a crown over a title. Wrap the title in

`\begin{floratitle} ... \end{floratitle}`; without it the first block of lines is crowned. - `surround`: a wreath round the text block, for title pages and contents. The flora fills whatever margins the page has, so give it room with `geometry` (about 5 cm for a side margin, or 3 cm all round for `surround`). It also grows into gaps in the text. A gap between lines taller than about three lines (40 pt), such as a `\vspace` left for a figure, opens across the text's full width and the flora reaches into it. The space below a short last page fills the same way.

使用方式

通过加载tikzflora宏包并使用\florasetup和\florathispage命令配置页面植物样式，支持多种布局和调色板。

查看 README 依据

\documentclass{article} \usepackage[left=5.5cm,right=2cm]{geometry} % room for the flora \usepackage{tikzflora} \florasetup{seed=7} \begin{document} Text. \end{document} ``` ## Settings `\florasetup{...}` sets keys for the rest of the document, from the page it is on. `\florathispage{...}` sets them for one page only. Mistakes stop the compile with a message naming the key. | Key | Values | Effect | |---|---|---| | `layout` | `left`, `right`, `centered`, `split`, `title`, `surround` | Where the flora grows (below) | | `seed` | a number, or `random` | Which garden; each page varies it |

| `mix` | `{kind=weight, ...}` | How much of each kind: 1 usual, 0 none, 2 about double | | `density` | 0 to 10 | Fuller (above 1) or airier (below 1) | | `visitors` | 0 to 10 | The weight of every visitor at once | | `palette` | `{part=ink, ...}` | What paints the `hero`, `blooms`, `leaves`, `leaflets`, `stems`, `sprays`, `ghost`, `cartouche` | | `spin` | a whole number | Picks other inks for parts set to `random`; the shapes stay | | `ornaments` | `{kind=weight, ...}` | How often each ornament kind is picked for its place; 0 never |

部署要求

需要支持LuaLaTeX的TeX发行版（TeX Live 2023或之后、MiKTeX或TinyTeX），示例使用lipsum宏包。

查看 README 依据

tikz-flora was written with Claude Code, Anthropic's coding agent. The art direction, the tuning against the reference and the choice of what to keep were done by hand. ## Setup You need a TeX distribution with **LuaLaTeX** (TeX Live 2023 or later, MiKTeX, or TinyTeX). Check with `lualatex --version`. The example also uses `lipsum` (`tlmgr install lipsum` on TinyTeX). 1. Download `tikzflora.zip` from the site, or build it with `just dist`. 2. Unzip it. It holds `tikzflora.sty`, `tikzflora-boot.lua`, the generator in `lua/flora/`, and `example.tex`.