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

Use of admonition / html tags #117

Open
AoifeHughes opened this issue Sep 9, 2022 · 0 comments
Open

Use of admonition / html tags #117

AoifeHughes opened this issue Sep 9, 2022 · 0 comments

Comments

@AoifeHughes
Copy link
Contributor

Just a thought whilst going through some of the first sections. I've noticed the use of details html tags to hide and show information. Are these vital or could we remove them? The primary reason I'd be inclined to remove is because they can cause issues with markdown e.g. they break []() linking.

Similarly, I've seen the admonition tag used a few times here, for example.. Does this add much, or could they also be removed?

I think it would generally help readability and compatibility (also happy to be told this is not something worth doing or that these things have a specific use!)

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

No branches or pull requests

1 participant