Skip to content

Add autoID for definition terms #13403

Closed
@bep

Description

@bep

We have a pretty good search setup on gohugo.io, but it's very annoying that we cannot link directly to the Definition terms.

These term listings are very convenient for documenting properties etc.

So, I will add autoID support for the terms

So,

Base Name
: Base name of the file.

Foo@Bar
: The foo bar.

Becomes

 <dl>
  <dt id="base-name">Base Name</dt>
  <dd>Base name of the file.</dd>
  <dt id="foobar">Foo@Bar</dt>
  <dd>The foo bar.</dd>
</dl>

Markdown parser config changes:

  • autoHeadingID (existing)
  • autoDefinitionTermID (new)
  • autoHeadingIDType renamed to autoIDType (it's not possible/practical to have 2 setting for this)

IDs will be added to Page.Fragments.Identifiers.

I will make sure that autoHeadingIDType will still work after this.

Note that the will share the same "auto ID context" as headings, so there will be no duplicate IDs.

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions