Skip to content

Add more information on behavior and usage of section links and document custom anchors #33530

@dodexahedron

Description

@dodexahedron

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#section-links

What part(s) of the article would you like to see updated?

For the Section links section:

The information in that section doesn't actually explain how the feature works or behaves. It only mentions one method to get the URL for an already-rendered section link in a document.

New section for custom anchors:

Custom anchors are allowed in GitHub markdown documents.
For precedent, explicit custom anchor tags are quite common in a lot of Microsoft Learn documents.

Proposal:

I have a PR drafted and ready to submit after I submit this issue, containing two (initial) commits:

  • One is a proposal for expansion of the Section links reusable, adding detail about how the feature works and an example that showcases several of the behaviors described.
  • The other is a proposal for addition of a new Custom anchors reusable, and the addition of a Custom anchors section below the other links sections of the Basic Writing and Formatting Syntax document

Additional information

No response

### Tasks
- [ ] https://github.com/github/docs/pull/33531

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamget startedContent related to "Getting Started" doc set

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions