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 method for including version changes #65

Open
pedro-psb opened this issue Jul 3, 2024 · 0 comments
Open

Add method for including version changes #65

pedro-psb opened this issue Jul 3, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@pedro-psb
Copy link
Member

We should have some standard on how to inform "Added in x.y.z", "Modified in x.y.z" and "Removed in x.y.z".

Ideally, people wont need to type the exact "added in", etc, which could lead to inconsistent styles of working and looking.
Using custom admonitions 1 looks a good balance between new and familiar syntax.

Also, I found a plugin 2 that's look having a look that does something like that.

Footnotes

  1. https://squidfunk.github.io/mkdocs-material/reference/admonitions/#custom-admonitions

  2. https://github.com/glennmatthews/markdown-version-annotations

@pedro-psb pedro-psb added the enhancement New feature or request label Jul 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant