documentationjs / documentationjs/documentation

Subheaders in html output (using a documentation.yml file)

Open
#670 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
5.8k
Forks
481
PR merge metrics
No merged PRs in 30d

Description

I am aware of how to configure things using the documentation.yml file
```
toc:
- Map
- name: Geography
description: |
These are Mapbox GL JS's ways of representing locations
and areas on the sphere.
- LngLat
```

is there a way to have a subheader too?
Something like (currently not implemented)
```
toc:
- Map
- name: Animals
description: |
Animals
- subname: Mammals
subdescription: |
Mammals
- Cat
- Dog
- subname: Birds
subdescription: |
Birds
- Dove
```
I hope my
```
Animals
> Mammals
- member
- member
> Birds
- member
```
makes sense.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.