Skip to content
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

✨ Add support for specifying lines and line ranges #31

Merged
merged 2 commits into from
Nov 23, 2022
Merged

✨ Add support for specifying lines and line ranges #31

merged 2 commits into from
Nov 23, 2022

Conversation

tiangolo
Copy link
Contributor

✨ Add support for specifying lines and line ranges.

For example:

{!filename!lines=1  3 8-10  2}

Thanks for this extension! It has been very useful, I use it to include all the examples for the docs for FastAPI and Typer. 🎉

That way I can test the same source files used in the documentation. ✔️

Now I want to use this extra feature I'm proposing to include specific lines or line ranges, in particular for a new project I'm building, to be able to focus the reader's attention on a particular segment of a file. While still having a complete valid file shown at the end, that can be copied and run, because it's also part of the tests.

I'm using almost the same syntax used to highlight lines with Material for MkDocs hl_lines hl_lines="1 3 8-10 2".

@ZedThree ZedThree merged commit 03c4ea0 into cmacmackin:master Nov 23, 2022
@tiangolo tiangolo deleted the lines-and-line-ranges branch November 23, 2022 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants