-
Notifications
You must be signed in to change notification settings - Fork 552
docs(ref): Specify frontmatter #1974
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
epage
wants to merge
3
commits into
rust-lang:master
Choose a base branch
from
epage:frontmatter
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ | |
- [Input format](input-format.md) | ||
- [Keywords](keywords.md) | ||
- [Identifiers](identifiers.md) | ||
- [Frontmatter](frontmatter.md) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I put this under "Lexical structure" because this shebang is there |
||
- [Comments](comments.md) | ||
- [Whitespace](whitespace.md) | ||
- [Tokens](tokens.md) | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
r[frontmatter] | ||
# Frontmatter | ||
|
||
r[frontmatter.syntax] | ||
```grammar,lexer | ||
@root FRONTMATTER -> | ||
FRONTMATTER_FENCE HORIZONTAL_WHITESPACE* INFOSTRING? HORIZONTAL_WHITESPACE* LF | ||
(FRONTMATTER_LINE LF )* | ||
FRONTMATTER_FENCE[^matched-fence] HORIZONTAL_WHITESPACE* LF | ||
|
||
FRONTMATTER_FENCE -> `---` `-`* | ||
|
||
INFOSTRING -> (XID_Start | `_`) ( XID_Continue | `-` | `.` )* | ||
|
||
FRONTMATTER_LINE -> (~INVALID_FRONTMATTER_LINE_START (~INVALID_FRONTMATTER_LINE_CONTINUE)*)? | ||
|
||
INVALID_FRONTMATTER_LINE_START -> (FRONTMATTER_FENCE[^escaped-fence] | LF) | ||
|
||
INVALID_FRONTMATTER_LINE_CONTINUE -> LF | ||
``` | ||
|
||
[^matched-fence]: The closing fence must have the same number of `-` as the opening fence | ||
[^escaped-fence]: A `FRONTMATTER_FENCE` at the beginning of a `FRONTMATTER_LINE` is only invalid if it has the same or more `-` as the `FRONTMATTER_FENCE` | ||
|
||
Frontmatter is an optional section for content intended for external tools without requiring these tools to have full knowledge of the Rust grammar. | ||
|
||
r[frontmatter.document] | ||
Frontmatter may only be preceded by a [shebang] and whitespace. | ||
|
||
r[frontmatter.fence] | ||
The delimiters are referred to as a "fence." | ||
The opening and closing fences must be at the start of a line. | ||
They must be a matching pair of three or more hyphens (`-`). | ||
A fence may be followed by horizontal whitespace. | ||
|
||
r[frontmatter.infostring] | ||
Following the opening fence may be an infostring for identifying the intention of the contained content. | ||
An infostring may be followed by horizontal whitespace. | ||
|
||
r[frontmatter.body] | ||
The body of the frontmatter may contain any content except for a line starting with as many or more hyphens (`-`) than in the fences. | ||
|
||
[shebang]: input-format.md#shebang-removal |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not stable yet: rust-lang/rust#136889