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

Implement new snippet plugin including offset functionality #4556

Closed
Tracked by #4069
snneji opened this issue Dec 13, 2021 · 4 comments
Closed
Tracked by #4069

Implement new snippet plugin including offset functionality #4556

snneji opened this issue Dec 13, 2021 · 4 comments
Labels
kind/infrastructure Docs infrastructure related lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/nice-to-have status/blocked

Comments

@snneji
Copy link
Contributor

snneji commented Dec 13, 2021

Context

To prevent duplication in docs we want to implement a snippets feature that meets our needs. Do this after #3769 is closed.

Tasks

  1. Implement the snippets plugin from the result of [SPIKE] Which content re-use plugin should we use?  #3769.
  2. Implement the offset functionality for the new plugin so that snippets can be included at the correct heading level in different places. For example, this one.
@csantanapr
Copy link
Member

I asked in material-mkdocs about it squidfunk/mkdocs-material#3581

@github-actions
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label May 16, 2022
@abrennan89 abrennan89 added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/nice-to-have and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/high labels Jun 9, 2022
@abrennan89
Copy link
Contributor

One of the nice things about asciidoc > markdown+mkdocs is that it provides this out of the box by using leveloffsets with inclusions: https://docs.asciidoctor.org/asciidoc/latest/directives/include/ (no add ons required)

I would still like to keep this on the table for someday future discussion, since I think it still solves a lot more of our wants / needs than markdown.

@abrennan89
Copy link
Contributor

Doesn't seem to be anything we can do about this one for now, closing until we find something else we can use, either for mkdocs or move to asciidoc etc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/infrastructure Docs infrastructure related lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/nice-to-have status/blocked
Projects
None yet
Development

No branches or pull requests

3 participants