injecturls

package
v1.5.54 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 20, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package injecturls is an mdbook preprocessor meant to collect urls via a comment directive.

Any string declaration with a directive like

//doc:url <keyword>

Will get added to a list and slip-streamed into the documentation where there's a preprocessor directive like

{{# injecturls <keyword> }}

Only go files are searched for directives. Any print verbs will be replaced with asterisks in the output.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Register

func Register(_ context.Context, cfg *mdbook.Context, p *mdbook.Proc) error

Register registers the preprocessor.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL