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

Extend TOC with links to other files too #264

Merged
merged 3 commits into from
Nov 21, 2022

Conversation

kirchsth
Copy link
Member

If a user opens https://plantuml-stdlib.github.io/C4-PlantUML/ he has no (direct) links to the other *.md files.

Therefore TOC of all deployed *.md files are updated that they can be accessed via https://plantuml-stdlib.github.io/C4-PlantUML/ too

It looks like

It can be checked with my extended branch

@Potherca: During tests I found in README.md some implicit links to LayoutOptions.md and one explicit to C4CoreDiagrams.md. If you want we could reject the PR too.

BR Helmut

Copy link
Member

@Potherca Potherca left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The TOC looks okay to me, my only concern is the use of the :page_facing_up shortcode, rather than the plain 📄 emoji.

As emoji shortcodes are not a generic Markdown feature but GitHub specific, it will not work in other context.

@Potherca Potherca added this to the v2.5.0 milestone Nov 19, 2022
@kirchsth
Copy link
Member Author

thank you for the hint, fixed (and changed encoding of C4CoreDiagrams.md to UTF8 too)

@kirchsth kirchsth merged commit efbcd2a into plantuml-stdlib:master Nov 21, 2022
@kirchsth kirchsth deleted the feature/TOC-link-all branch November 21, 2022 11:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants