1
0
mirror of synced 2026-01-10 09:02:35 -05:00
Files
docs/data/reusables
Amy Burns ae96cd2cc5 Adding more information on how to use github.dev (#21576)
* making some minor improvements based on feedback

* added new product name and some improvements

* updating location and feedback

* updating doc based on PM feedback

* Apply suggestions from code review

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>

* adding some updates based on feedback

* renaming file to match new SEO friendly title

* updating based on feedback

* updating based on feedback

Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
2021-09-29 21:53:27 -04:00
..
2021-08-19 18:18:00 +00:00
2021-08-19 18:18:00 +00:00
2021-08-19 18:18:00 +00:00
2020-09-27 14:10:11 +02:00
2021-04-21 16:13:38 -04:00
2021-09-10 13:48:54 +00:00
2021-08-19 18:18:00 +00:00
2021-07-21 14:03:36 -04:00
2020-09-27 14:10:11 +02:00
2020-09-27 14:10:11 +02:00

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 %}.