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.

Sign up for GitHub

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

Jump to bottom

Fix markdown headers in rmk doc generate to display correctly in the web documentation. #42

Closed
1 task done
anovikov-el opened this issue Sep 2, 2024 · 0 comments · Fixed by #43
Closed
1 task done

Fix markdown headers in rmk doc generate to display correctly in the web documentation. #42

anovikov-el opened this issue Sep 2, 2024 · 0 comments · Fixed by #43
Assignees
@apanasiuk-el
Labels
bug Something isn't working

Comments

@anovikov-el
Copy link
Contributor

anovikov-el commented Sep 2, 2024 •
edited
Loading

Description

Currently, rmk doc generate produces a markdown, which contains multiple headers of a level 1.

This should be fixed to embed into the web documentation, so a navigation tree to the right could be built by MkDocs correctly: https://edenlabllc.github.io/rmk/v0.43.0/commands/

The v0.43.0 documentation has been adjusted manually as an example.

Increase the levels of all headers to 2+ (NAME is the only exclusion, it should remain the same).

Steps to reproduce

  1. Run rmk doc generate
  2. Check the headers in the result markdown.

Expected behaviour

# NAME

...

## SYNOPSIS

...

## DESCRIPTION

...

## GLOBAL OPTIONS

...

## COMMANDS

### cluster

Actual behaviour

# NAME

...

# SYNOPSIS

...

# DESCRIPTION

...

# GLOBAL OPTIONS

...

# COMMANDS

## cluster

Environment info

RMK: any
OS: any
Shell: any
Terminal: any

Agree to the Code of Conduct

  • I agree to follow this project's Code of Conduct
@anovikov-el anovikov-el added the bug Something isn't working label Sep 2, 2024
apanasiuk-el added a commit that referenced this issue Sep 2, 2024
@apanasiuk-el
#42 - fix markdown headers in rmk doc generate command
f483d4b
@apanasiuk-el apanasiuk-el linked a pull request Sep 2, 2024 that will close this issue
#42 - fix markdown headers in rmk doc generate command #43
Merged
apanasiuk-el added a commit that referenced this issue Sep 2, 2024
@apanasiuk-el
#42 - refactoring
7695de3
apanasiuk-el added a commit that referenced this issue Sep 2, 2024
@apanasiuk-el
#42 - refactoring
455acd0
apanasiuk-el added a commit that referenced this issue Sep 2, 2024
@apanasiuk-el
Merge pull request #43 from edenlabllc/feature/RMK-42-fix-markdown-he…
edbe501 
…aders-in-rmk-doc-generate-to-display-correctly-in-the-web-documentation

#42 - fix markdown headers in rmk doc generate command
apanasiuk-el added a commit that referenced this issue Sep 3, 2024
@apanasiuk-el
#42 - refactoring GitHub workflow
03f8918
apanasiuk-el added a commit that referenced this issue Sep 3, 2024
@apanasiuk-el
#42 - refactoring
56a0f1b
apanasiuk-el added a commit that referenced this issue Sep 3, 2024
@apanasiuk-el
Merge pull request #45 from edenlabllc/feature/RMK-42-fix-markdown-he…
2b37748 
…aders-in-rmk-doc-generate-to-display-correctly-in-the-web-documentation

#42 - refactoring GitHub workflow
apanasiuk-el added a commit that referenced this issue Sep 3, 2024
@apanasiuk-el
#42 - refactoring
2298195
apanasiuk-el added a commit that referenced this issue Sep 3, 2024
@apanasiuk-el
Merge pull request #46 from edenlabllc/feature/RMK-42-fix-markdown-he…
25e5886 
…aders-in-rmk-doc-generate-to-display-correctly-in-the-web-documentation

#42 - refactoring
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@apanasiuk-el apanasiuk-el

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#42 - fix markdown headers in rmk doc generate command edenlabllc/rmk
2 participants
@anovikov-el @apanasiuk-el