nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-26 08:44:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #109229 - DaniPopes:link-references, r=notriddle

Browse Source 
Fix invalid markdown link references

Fixes invalid link references in librustdoc's template documentation.
`[text](link)` was interpreted as a relative path to the file, making the link invalid, while `[text][label]` references a label defined in the file itself: <https://www.markdownguide.org/basic-syntax/#reference-style-links>
This commit is contained in:
Matthias Krüger 2023-03-17 08:42:41 +01:00 committed by GitHub
commit 0584bde849
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/librustdoc/html/templates/STYLE.md
View File

@ -1,12 +1,12 @@
# Style for Templates # Style for Templates
This directory has templates in the [Tera templating language](teradoc), which is very This directory has templates in the [Tera templating language][teradoc], which is very
similar to [Jinja2](jinjadoc) and [Django](djangodoc) templates, and also to [Askama](askamadoc). similar to [Jinja2][jinjadoc] and [Django][djangodoc] templates, and also to [Askama][askamadoc].
[teradoc]: https://tera.netlify.app/docs/#templates [teradoc]: https://tera.netlify.app/docs/#templates
[jinjadoc]: https://jinja.palletsprojects.com/en/3.0.x/templates/ [jinjadoc]: https://jinja.palletsprojects.com/en/3.1.x/templates/
[djangodoc]: https://docs.djangoproject.com/en/3.2/topics/templates/ [djangodoc]: https://docs.djangoproject.com/en/4.1/topics/templates/
[askamadoc]: https://docs.rs/askama/0.10.5/askama/ [askamadoc]: https://docs.rs/askama/latest/askama/
We want our rendered output to have as little unnecessary whitespace as We want our rendered output to have as little unnecessary whitespace as
possible, so that pages load quickly. To achieve that we use Tera's possible, so that pages load quickly. To achieve that we use Tera's
@ -30,8 +30,8 @@ contents don't necessarily need a new line.
Askama templates support quite sophisticated control flow. To keep our templates Askama templates support quite sophisticated control flow. To keep our templates
simple and understandable, we use only a subset: `if` and `for`. In particular simple and understandable, we use only a subset: `if` and `for`. In particular
we avoid [assignments in the template logic](assignments) and [Askama we avoid [assignments in the template logic][assignments] and [Askama
macros](macros). This also may make things easier if we switch to a different macros][macros]. This also may make things easier if we switch to a different
Jinja-style template system, like Askama, in the future. Jinja-style template system, like Askama, in the future.
[assignments]: https://djc.github.io/askama/template_syntax.html#assignments [assignments]: https://djc.github.io/askama/template_syntax.html#assignments