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

Is it possible to have TOC include some headings from the md file? #134

Open
stratus-ss opened this issue Apr 1, 2024 · 0 comments
Open

Comments

@stratus-ss
Copy link

stratus-ss commented Apr 1, 2024

Let's say I have a summary file like this

- [Installing The Operators](rhoai_installing_operators.md)
    - [Installing The NVIDIA GPU Operator](blank.md)
        - [NVIDIA Cluster Monitoring](nvidia_cluster_monitoring_cli.md)

Inside Cluster Monitoring I have 3 different headings in the file itself:

## Enabling Monitoring Dashboard

<stuff> ...

## Enabling The NVIDIA GPU Operator Dashboard

<stuff> ...

## Using NVIDIA SMI

<stuff> ...

The headings work exactly as I expect when stitchmd does it's thing. In wiki software you can do things like include a maximum depth included in the TOC so that you can say have an H3 be included by not H4 +.

I know I could break these sections into their own file and include those in the summary to accomplish the same. But instead of having to break up files into tiny ones, I was wondering if it is possible to do the above? You can see my doc example here

I'd like to see:

* Installing The Operators
  * Installing the NVIDIA GPU Operator
    * NVIDIA Cluster Monitoring
      * Enabling Monitoring Dashboard
      * Enabling The NVIDIA GPU Operator Dashboard
      * Using NVIDIA SMI

In the TOC

@stratus-ss stratus-ss changed the title Is it possible to have TOC use heading inside a file? Is it possible to have TOC include some headings in the md file? Apr 1, 2024
@stratus-ss stratus-ss changed the title Is it possible to have TOC include some headings in the md file? Is it possible to have TOC include some headings from the md file? Apr 1, 2024
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