Shared Section Reference
All three PTKRDME tools share the same set of built-in section types. Each section defines typed fields, a render strategy, and optionally an autodetection class that scans project metadata to pre-populate values.
Installation
Order: 1Four input fields for install, build, test, and run commands.
License
Order: 3Single select from 93 SPDX-standard license IDs. Fetches full license text from an API endpoint.
Brands
Order: 2Multi-select from ~3100 simple-icons slugs. Has autodetection that matches project dependencies to icons.
Shields
Order: 0Multi-select from a catalog of ~10K shields.io badges. Has autodetection for your project's tech stack.
Related Projects
Order: 4Repeater field for name+URL pairs. Has autodetection that extracts dependencies with repository URLs.
Every section follows this lifecycle: define in ptkrdmelib, rebuild, then register in each consumer.
Field Types
Every section's configoptions array uses these field types, shared across all three consumers:
- input
- Single text field. Used for short string values like commands or URLs.
- textarea
- Multi-line text area for longer content.
- select
- Single-choice dropdown. Options is an array of string choices.
- multi-select
- Checkbox grid. Value is an array of selected slugs.
- repeater
- Dynamic list of name/URL pairs. Users can add or remove items.
- shields
- Multi-select of shields.io badges with path parameters and style.