Guidedog マニュアル 0.2.0
言語
このページの内容
Guidedog / ドキュメント 0.2.0

defaults

Package defaults assembles the built-in readers and renderers into an explicit, immutable registry. Embedders may build their own registry from any subset.

Procedures

defaults.myst_options :: proc(settings: ^commonmark.Settings, base := gd.Read_Options{}) -> gd.Read_Options

myst_options reads with the 「myst」 reader’s settings, from commonmark.default_settings or sphinx.markdown_settings. It borrows settings, as rst_options does.

defaults.registry :: proc() -> gd.Registry

registry returns the built-in registry by value; it borrows static tables, valid for the whole program. Readers: 「rst」, 「sphinx」, 「commonmark」 (pure CommonMark), and 「myst」 (MyST Markdown). Renderers: 「html」, 「typst」, and 「text」.

defaults.rst_options :: proc(settings: ^rst.Settings, base := gd.Read_Options{}) -> gd.Read_Options

rst_options reads with the 「rst」 reader’s settings (rst.default_settings() to start). It borrows settings; base, when not zero, supplies the other read options.

defaults.sphinx_options :: proc(config: ^sphinx.Config, base := gd.Read_Options{}) -> gd.Read_Options

sphinx_options reads with the 「sphinx」 reader’s configuration (sphinx.default_config() to start). It borrows config, as rst_options does.