home.social

#autorefs — Public Fediverse posts

Live and recent posts from across the Fediverse tagged #autorefs, aggregated by home.social.

fetched live
  1. The plugin for will now warn you when you cross-reference a heading using its id, and this id is found in multiple pages.

    This will fail builds in strict mode.

    In that case it will suggest that you use unique headings (not always easy to do), ids (see below) or Markdown anchors (recent feature):

    ```md
    The following headings appear in other pages:

    ## Heading A {#unique-heading-a}

    [](){#unique-heading-b}
    ## Heading B
    ```

    (see following toot)

  2. The #autorefs plugin for #MkDocs will now warn you when you cross-reference a heading using its id, and this id is found in multiple pages.

    This will fail builds in strict mode.

    In that case it will suggest that you use unique headings (not always easy to do), ids (see below) or Markdown anchors (recent feature):

    ```md
    The following headings appear in other pages:

    ## Heading A {#unique-heading-a}

    [](){#unique-heading-b}
    ## Heading B
    ```

    (see following toot)

  3. Our plugin, , just gained a new feature in v1.0: Markdown anchors and aliases.

    Add anchors anywhere in a document, and cross-reference it with the usual syntax:

    ```
    [](){#anchor-id}

    [Cross-ref to the anchor][anchor-id]
    ```

    Right above a heading, such an anchor serves as an alias to the heading!

    ```
    [](){#heading-alias}
    ## Some heading

    [Cross-ref to heading][heading-alias]
    ```

    See the docs: mkdocstrings.github.io/autoref