Skip to content

Feat/gitlab toc #17

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

Merged
ebuildy merged 7 commits into from
Jun 29, 2026
Merged

Feat/gitlab toc #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5ee5a03
docs: design spec for GitLab [[_TOC_]] marker rendering
ebuildy Jun 28, 2026
473e5ab
docs: extend TOC depth to h2-h5 and consistent multi-level nesting
ebuildy Jun 28, 2026
1fd819e
docs: implementation plan for GitLab [[_TOC_]] support
ebuildy Jun 28, 2026
f834fe0
build: add github-slugger and hast-util-to-string deps
ebuildy Jun 28, 2026
7deba1d
feat: render GitLab [[_TOC_]] marker as a real table of contents
ebuildy Jun 29, 2026
df1aac5
test: cover scoped ids, nesting, dedupe, edge cases, and XSS for TOC
ebuildy Jun 29, 2026
30a8398
docs: document [[_TOC_]] support and gitlab-md-toc class
ebuildy Jun 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,11 @@ localized; links resolve back to GitLab.
| `project` | string \| number | — | **Required.** |
| `ref` | string | default branch | Branch, tag, or commit SHA |

> **Table of contents:** if the README contains a GitLab `[[_TOC_]]` marker on its
> own line, it is replaced at build time with a generated table of contents linking
> to the document's `h2`–`h5` headings (which receive slug `id`s). This also works
> for markdown embedded via `<GitlabFile>` and for release notes.

### `<GitlabReleases>`

A list of releases with notes, dates, and asset links.
Expand Down Expand Up @@ -227,6 +232,7 @@ into your `src/css/custom.css` and edit freely. The class names you can target:
| `gitlab-releases` / `gitlab-release` | releases list + each release card |
| `gitlab-release-notes` / `gitlab-release-assets` | release body + asset links |
| `gitlab-readme` | rendered README / markdown file |
| `gitlab-md-toc` | generated `[[_TOC_]]` table of contents (`<nav>`) |
| `gitlab-fallback` | error fallback box |
| `gitlab-code` / `gitlab-code-title` / `gitlab-code-pre` | code file embed |

Expand Down
Loading
Loading