Skip to content

Files

This branch is 2485 commits behind github/docs:main.

reusables

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jun 13, 2024
Aug 20, 2024
Dec 21, 2023
Aug 22, 2024
Jan 18, 2024
Aug 8, 2024
Aug 14, 2024
Aug 26, 2024
Jun 22, 2023
Jul 15, 2024
Jun 13, 2024
Aug 28, 2024
Jun 18, 2024
Jul 7, 2024
Jul 4, 2024
Jun 13, 2024
Jun 13, 2024
Jun 13, 2024
Aug 26, 2024
Aug 8, 2024
Aug 27, 2024
Jun 13, 2024
Jul 30, 2024
Jul 29, 2024
Jul 29, 2024
Jul 29, 2024
Jun 13, 2024
Feb 15, 2023
Jan 28, 2024
Feb 15, 2023
Aug 1, 2024
Jun 13, 2024
Aug 7, 2024
Aug 16, 2024
May 14, 2024
Aug 7, 2024
Aug 28, 2024
Aug 28, 2024
Jul 12, 2024
Aug 11, 2024
Aug 11, 2024
Mar 7, 2023
Aug 8, 2024
Feb 15, 2024
Jun 13, 2024
Jun 13, 2024
Aug 7, 2024
Jun 21, 2023
May 16, 2024
Mar 27, 2023
Aug 28, 2024
Feb 7, 2024
Jul 30, 2024
Feb 1, 2024
Jun 13, 2024
May 14, 2024
Jul 17, 2024
Aug 26, 2024
Nov 13, 2020
Feb 5, 2024
Jun 3, 2024
Sep 27, 2020
Jun 13, 2024
Apr 17, 2024
Mar 29, 2022
Jun 23, 2023
Jul 8, 2024
Jun 6, 2022
Aug 27, 2024
Jul 18, 2024
Aug 15, 2024
Aug 7, 2024
Oct 26, 2023
Jan 23, 2024
Jul 28, 2023
Jun 24, 2024
Jun 13, 2024
Jul 12, 2024
Jul 12, 2024
Aug 14, 2024
Aug 26, 2024
Jun 13, 2024
Jun 13, 2024
Aug 12, 2024
Jun 13, 2024
Aug 7, 2024
Aug 7, 2024
Aug 15, 2024
Aug 20, 2024
Jun 19, 2024
Jul 10, 2024
Aug 8, 2024
Jul 30, 2024
Jun 26, 2023
Jan 2, 2024
Aug 6, 2024
Jun 13, 2024
Sep 21, 2023
Jan 8, 2024
Jun 21, 2024
Jul 9, 2024
Jun 23, 2023
Aug 7, 2024
Aug 19, 2024
Oct 25, 2022
Aug 14, 2024
Sep 25, 2023

Reusables

Reusables are long strings of reusable text.

Reusables are longer strings like paragraphs or procedural lists that can be referenced in multiple content files. Using Markdown (instead of YAML) makes it possible for our localization pipeline to split the strings into smaller translatable segments, leading to fewer translation errors and less churn when the source English content changes.

Each reusable lives in its own Markdown file.

The path and filename of each Markdown file determines what its path will be in the data object.

For example, a file named /data/reusables/foo/bar.md will be accessible as {% data reusables.foo.bar %} in pages.

Reusable files are divided generally into directories by task. For example, if you're creating a reusable string for articles about GitHub notifications, you'd add it in the directory data/reusables/notifications/ in a file named data/reusables/notifications/your-reusable-name.md. The content reference you'd add to the source would look like {% data reusables.notifications.your-reusable-name %}.

Indenting

Indented reusables require a special liquid tag: indented_data_reference which also requires the number of spaces to indent as an argument.

For example, to indent /data/reusables/foo/bar.md in an ordered list, you could:

1. My first list item
{% indented_data_reference reusables.foo.par spaces=2 %}
1. My second list item

Versioning

Reusables can include Liquid conditionals to conditionally render content depending on the current version being viewed. See contributing/liquid-helpers.md.