singleh1

package

v0.23.0 Latest Latest Go to latest Published: May 21, 2026 License: MIT Imports: 8 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Rule struct {
	FrontMatterTitle string // front-matter field that counts as an H1 (empty = disabled)
}

Rule checks that at most one H1 heading appears per file.

func (r *Rule) ApplySettings(s map[string]any) error

ApplySettings implements rule.Configurable.

func (r *Rule) Category() string

Category implements rule.Rule.

func (r *Rule) Check(f *lint.File) []lint.Diagnostic

Check implements rule.Rule.

func (r *Rule) DefaultSettings() map[string]any

DefaultSettings implements rule.Configurable.

func (r *Rule) EnabledByDefault() bool

EnabledByDefault implements rule.Defaultable.

func (r *Rule) Fix(f *lint.File) []byte

Fix implements rule.FixableRule. Demotes extra H1s to H2. Does not auto-fix front-matter title conflicts.

func (r *Rule) ID() string

ID implements rule.Rule.

func (r *Rule) Name() string

Name implements rule.Rule.