Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Multiline markdown footnote syntax in Getting Started docs does not work for *.md pages. #40887

Open
Labels
contentThis issue or pull request belongs to the Docs Content team get startedContent related to "Getting Started" doc set
@timothyhull

Description

Code of Conduct

What article on docs.github.com is affected?

https://github.com/github/docs/blob/main/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md#footnotes

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

The Footnotes section provides incorrect instructions for multiline footnotes. The section reads:

Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
[^1]: My reference.
[^2]: To add line breaks within a footnote, prefix new lines with 2 spaces.
 This is a second line.

Using this syntax, GitHub markdown renders what should be the second line at the end of the first line. The correct form of the syntax is to place two spaces at the end of a line that prefixes a new line:

Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
[^1]: My reference.
[^2]: To add line breaks within a footnote, add 2 spaces to the end of a line. 
This is a second line.

Updating this content will allow people to use the GitHub Getting Started documentation to successfully implement multiline footnotes within markdown files.

Additional information

I can reliably reproduce and resolve the problem with *.md pages rendered on GitHub.com. Prefixing additional lines of a footnote with 2 spaces does not produce a multiline footnote; adding 2 spaces to the end of lines that prefix additional lines of a footnote correctly produces a multiline footnote. Curiously, both placements of 2 spaces work correctly in other GitHub elements that support markdown (Issue and Pull Request descriptions, comments, etc.).

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content team get 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

        AltStyle によって変換されたページ (->オリジナル) /