markdown

Subscribe to all “markdown” posts via RSS or follow GitHub Changelog on Twitter to stay updated on everything we ship.

→ ~ cd github-changelog
→ ~/github-changelog|main git log main
showing all changes successfully

Preview the Markdown rendering of gists

You can now preview renderings of Markdown files that you edit in GitHub Gist.

It has long been possible to preview the Markdown rendering of file edits or comments on GitHub. But these Markdown previews weren't available for gist files. Now, when creating or editing a gist file with the Markdown (.md) file extension, a Preview or Preview changes tab will display a Markdown rendering of the file contents. This lets you easily switch between the source view and Markdown view of the file.

image

For more information about gists, visit Editing and sharing content with gists. Get started by creating a secret gist, or a public gist for sharing, at gist.github.com.

See more

Keyboard shortcuts for quotes and lists

We've added keyboard shortcuts for quotes and lists in Markdown files, issues, PRs and comments.

To add quotes, use cmd+shift+. on Mac or ctrl+shift+. on Windows/Linux.
To add an ordered list, use cmd+shift+7 on Mac or ctrl+shift+7 on Windows/Linux.
To add an unordered list, use cmd+shift+8 on Mac or ctrl+shift+8 on Windows/Linux.

Keyboard shortcuts

For a full list of all our keyboard shortcuts, see our docs.

See more

Fixed-width font support in Markdown-enabled fields

You can now choose to use a fixed-width font in Markdown-enabled fields, like issue comments and pull request descriptions. Currently these fields use a variable-width font, which can make it difficult to edit advanced Markdown structures like tables and code snippets.

To enable, go to your appearance settings and toggle on Use a fixed-width (monospace) font when editing Markdown in the “Markdown editor font preference” section.

fixed-width-font

Learn more about writing and formatting on GitHub.

See more

Footnotes now supported in Markdown fields

Footnotes let you reference relevant information without disrupting the flow of what you're trying to say:

Here is a simple footnote[^1]. With some additional text after it.

[^1]: My reference.

You can now use footnote syntax in any Markdown field!

Footnotes are displayed as superscript links. Click them to jump to their referenced information, displayed in a new section at the bottom of the document:

footnote-cropped

Learn more about using footnotes in Markdown.

See more

What’s new with GitHub Issues

GitHub Issues banner image

Today we are announcing new beta features within GitHub Issues, with better ways to plan, track, and manage projects.

Read more on the GitHub Issues page or in the FAQ.

✨ NEW – Project planning for developers

Available in limited public beta

Built like a spreadsheet, project tables give you a live canvas to filter, sort, and group issues and pull requests. Tailor them to your needs with custom fields and saved views. Sign up for the beta now.

  • Prioritize your work across repositories with a new spreadsheet-like table
  • Extend issues with custom fields with support for text, number, date and single-select types
  • Change custom field values right from the issues sidebar
  • Filter, sort, and group by any field
  • Instantly switch between project tables and boards
  • Save your view options to share with your team
  • Build custom workflows with a GraphQL API to access project issues and metadata
  • Use cmd + k to bring up a command palette that lets you filter, sort, group, and manage views

✨ NEW – Break issues into actionable tasks

Available in public beta

When lists of tasks are created in markdown and referenced in another issue, this will now create a dynamic relationship that helps you break down your work and track it to completion. Convert text into issues quickly after brainstorming ideas with your team, and stay up to date on progress now that tracked issues are automatically checked off when closed.

  • Create task lists of issues and pull requests
  • Quickly convert text into issues
  • Track status of tasks with progress indicators
  • See which issues another issue is being tracked in
  • Automatically update the status of a task when the tracked issue is closed

View the progress of your issues and see how work is related with task lists

📣 Got feedback?

Join our feedback community and let us know how we can improve.

See more