Skip to content

Mkdocs format#9

Merged
macpijan merged 3 commits intomainfrom
mkdocs_format
Jan 4, 2024
Merged

Mkdocs format#9
macpijan merged 3 commits intomainfrom
mkdocs_format

Conversation

@miczyg1
Copy link
Contributor

@miczyg1 miczyg1 commented Dec 27, 2023

Added a switch that changes the heading levels to produce a ready-to-paste report into docs.dasharo.com mkdocs

Signed-off-by: Michał Żygowski <michal.zygowski@3mdeb.com>
Signed-off-by: Michał Żygowski <michal.zygowski@3mdeb.com>
Signed-off-by: Michał Żygowski <michal.zygowski@3mdeb.com>
@miczyg1 miczyg1 requested a review from macpijan January 4, 2024 11:46
@macpijan
Copy link
Contributor

macpijan commented Jan 4, 2024

Making it easier to integrate in docs.dasharo.com is great idea. Although I am wondering, if we need multiple formats? After all, it is mostly used by us, and "mkdocs" format is also a valid markdown?

@miczyg1
Copy link
Contributor Author

miczyg1 commented Jan 4, 2024

Making it easier to integrate in docs.dasharo.com is great idea. Although I am wondering, if we need multiple formats? After all, it is mostly used by us, and "mkdocs" format is also a valid markdown?

Format is the same, just heading levels are different. My idea was to lower the heading levels so that only the 2nd level heading (which is the Dasharo version the report was generated for) would appear in TOC on mkdocs for better browsability

@macpijan
Copy link
Contributor

macpijan commented Jan 4, 2024

Format is the same, just heading levels are different. My idea was to lower the heading levels so that only the 2nd level heading (which is the Dasharo version the report was generated for) would appear in TOC on mkdocs for better browsability

Right, so we could simply change that, without the necessity of supporting two variants of heading levels? We make it more complex, and need to edit other script using it to pass a new parameter as well. But if you believe it is worth to keep these 2 styles, I am fine with that.

@miczyg1
Copy link
Contributor Author

miczyg1 commented Jan 4, 2024

Right, so we could simply change that, without the necessity of supporting two variants of heading levels? We make it more complex, and need to edit other script using it to pass a new parameter as well. But if you believe it is worth to keep these 2 styles, I am fine with that.

We need two of them, because you may use the utility to produce a standalone report which has to keep the proper hierarchy of headings. Plus for the mkdocs I skip the top level heading

@macpijan macpijan merged commit 43f559b into main Jan 4, 2024
@macpijan macpijan deleted the mkdocs_format branch January 4, 2024 13:23
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