Linkers¶
Linkers are commands which link the headers with URLs for users to follow to the external documentation.
They are simply passed with the details of the headers, and return a URL that is then hyperlinked to the respective header.
Distribution¶
Following is information on the distribution of the linkers
Comparison¶
| ~ | Official Repository | 3rd-party |
|---|---|---|
| Distribution | From base package | Yourself. Users will have to install the package before using it. |
| Configuration | ❌ | Optional |
| Updates | Delayed for review | Direct |
Methods¶
Different methods of distribution available to packagers
Official Repository¶
Each linker is a single function in the repository which provides URLs for the specific documentation website/framework it corresponds to.
Gaze at Pre-existing linkers
Have a look at other packages defined in the repository before pushing your own here.
Anti-legacy
Legacy software with modern alternatives won't be included in the official repository.
Tradition, familiarity with the legacy, inertia towards innovation—these won't be reasons accepted for "contributions."
The ancients can build their own museum (legacy-stone repository).
3rd-party¶
3rd-party packages/repositories can use the program however they want.
You might be able to get some creative inspiration by exploring existing packages/repositories, or you could also choose an unofficial repository if it suits your project better.
Discovery
Make your 3rd-party project discoverable with the topic: helptext-linker