Add {{#shiftinclude}} command #2333
Open
Conversation
This file contains 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
Syntax is the same as {{#include}} except with a shift value and colon
before the remaining arguments, e.g.
{{#include -2:somefile.rs:myanchor}}
A positive value for the shift prepends spaces to each line.
A negative value for the shift removes chars from the beginning of each
line (including non-whitespace chars, although this will emit an error
log).
As well as allowing explicitly-specified shift amounts, also support an "auto" option that strips common leftmost whitespace from an inclusion.
daviddrysdale
force-pushed
the
left-shift
branch
from
4b1b97b
to
a886ff5
Compare
daviddrysdale
added a commit
to daviddrysdale/mdbook-shiftinclude
that referenced
this pull request
Mar 30, 2024
Taken from suggested pull request for upstream: rust-lang/mdBook#2333
daviddrysdale
added a commit
to daviddrysdale/mdbook-shiftinclude
that referenced
this pull request
Mar 30, 2024
Taken from suggested pull request for upstream: rust-lang/mdBook#2333
daviddrysdale
added a commit
to daviddrysdale/mdbook-shiftinclude
that referenced
this pull request
Mar 30, 2024
Taken from suggested pull request for upstream: rust-lang/mdBook#2333
|
Given that this looks unlikely to be included in the main mdBook code, I've pulled the functionality out into a separate |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Allows included code to be shifted left or right by a specified amount, or to be automatically left-shifted so that common leading whitespace is stripped.
Uses a new command name
#shiftincludeto avoid changing the behaviour of any existing books.There are few open issues1 that this might help with :
{{#shiftinclude auto:file.rs}}here.{{#include ...}}with indented #1564{{#shiftinclude +4:myfn.rs}}here.{{#shiftinclude auto:file.rs}}here.{{#shiftinclude +4:../exercises/chapter6/test/no-peeking/Solutions.purs:eqNonEmpty}}(but would need to be left-aligned).There are also a few open PRs that this might overtake/replace/combine-with:
{{#include}}is indented #1565autovariant here (and is also careful not to affect existing behaviour).Footnotes
I confess that I implemented this without looking at the current open issues/pull requests. ↩