Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Plugin Configuration

Plugins are configured through typewriter.toml.

Plugin Discovery

[plugins]
# Directory to scan for .so/.dylib/.dll files
dir = "~/.typewriter/plugins/"

# Explicit paths to plugin libraries
paths = [
    "./my-plugins/libtypewriter_plugin_ruby.so",
]

Plugin-Specific Settings

Each plugin can have its own TOML section using its language_id as the key:

[ruby]
output_dir = "./generated/ruby"
file_style = "snake_case"

[php]
output_dir = "./generated/php"
file_style = "PascalCase"

[dart]
output_dir = "./generated/dart"
file_style = "snake_case"

Standard Keys

All plugins support these standard keys:

KeyTypeDescription
output_dirStringOutput directory for generated files
file_styleStringFile naming style: snake_case, kebab-case, PascalCase

Additional keys are passed to the plugin via PluginConfig.extra.