Skip to content

Commit 4000876

Browse files
committed
website: try adding a TOC to nersc/index.md
1 parent cd4d217 commit 4000876

2 files changed

Lines changed: 24 additions & 10 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ export default defineConfig({
2626
sidebar: {
2727
"/nersc/": [
2828
{
29-
text: "Connecting to NERSC",
29+
text: "At NERSC",
3030
items: [
31-
{ text: "Login", link: "/nersc/login" },
32-
{ text: "Installation", link: "/nersc/installation" },
31+
{ text: "Quickstart", link: "/nersc/index" },
32+
{ text: "Installation", link: "/nersc/installation_at_nersc" },
3333
],
3434
},
3535
{
36-
text: "Perlmutter",
36+
text: "Step-by-step Guides",
3737
items: [
38-
{ text: "Quick View", link: "/nersc/perlmutter-run-quickview" },
38+
{ text: "QuickView", link: "/nersc/perlmutter-run-quickview" },
3939
{
40-
text: "Quick Compare",
40+
text: "QuickCompare",
4141
link: "/nersc/perlmutter-run-quickcompare",
4242
},
4343
],
@@ -66,12 +66,12 @@ export default defineConfig({
6666
{
6767
text: "QuickCompare",
6868
items: [
69-
{ text: "Getting started", link: "/guides/quickcompare" },
7069
{ text: "Resources", link: "/guides/quickcompare/resources" },
70+
{ text: "Getting started", link: "/guides/quickcompare" },
7171
],
7272
},
7373
{
74-
text: "Development",
74+
text: "For app Developers",
7575
items: [
7676
{ text: "Setup", link: "/guides/dev/setup" },
7777
{ text: "Continuous Integration", link: "/guides/dev/ci" },
@@ -84,4 +84,16 @@ export default defineConfig({
8484
{ icon: "github", link: "https://github.com/Kitware/QuickView" },
8585
],
8686
},
87+
88+
markdown: {
89+
// Options for the Table of Contents plugin
90+
toc: {
91+
level: [2, 3] // Only include <h2> and <h3> in the TOC
92+
},
93+
// Options for heading anchors (optional)
94+
anchor: {
95+
permalink: true // Enables clickable anchor links on headings
96+
}
97+
},
98+
8799
});

docs/nersc/index.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# The QuickView tool family at NERSC
22

33
Our tools have been installed at NERSC,
4-
the National Energy Research Scientific Computing Center,
4+
the [National Energy Research Scientific Computing Center](https://www.nersc.gov/)
55
and are continually updated there.
6-
Below are instructions for users who would like to use our installations.
6+
The following sections on this page contain instructions for users who would like to use our installations.
7+
8+
[[toc]]
79

810
User's who would like to understand how our installation was done
911
or how to have their own installation are referred to [this page](installation_at_nersc.md).

0 commit comments

Comments
 (0)