From cc75daa1ba70c69113aeaf9902eb212e38ccf1b8 Mon Sep 17 00:00:00 2001 From: Felix Moeser Date: Fri, 10 May 2024 16:23:14 +0200 Subject: [PATCH 1/3] Navbar structure --- website/docs/Configuration/index.md | 1 - website/docs/configuration/_category_.yaml | 7 +++++++ website/docs/dictionaries/_category_.yaml | 7 +++++++ .../custom-dictionaries.md} | 3 ++- website/docs/{dictionaries.md => dictionaries/index.md} | 3 ++- .../searching-dictionaries.md} | 3 ++- website/docs/getting-started.md | 3 ++- website/docs/installation.md | 3 ++- website/src/css/custom.css | 4 ++++ 9 files changed, 28 insertions(+), 6 deletions(-) create mode 100644 website/docs/configuration/_category_.yaml create mode 100644 website/docs/dictionaries/_category_.yaml rename website/docs/{dictionaries-custom.md => dictionaries/custom-dictionaries.md} (97%) rename website/docs/{dictionaries.md => dictionaries/index.md} (98%) rename website/docs/{command-trace.md => dictionaries/searching-dictionaries.md} (97%) diff --git a/website/docs/Configuration/index.md b/website/docs/Configuration/index.md index f7273a1e2d0..d43fc7bd681 100644 --- a/website/docs/Configuration/index.md +++ b/website/docs/Configuration/index.md @@ -1,6 +1,5 @@ --- title: Configuration -nav_order: 4 description: 'Customizing CSpell' has_children: true --- diff --git a/website/docs/configuration/_category_.yaml b/website/docs/configuration/_category_.yaml new file mode 100644 index 00000000000..68aeef92896 --- /dev/null +++ b/website/docs/configuration/_category_.yaml @@ -0,0 +1,7 @@ +position: 3 +label: 'Configuration' +collapsible: true # make the category collapsible +collapsed: false # keep the category open by default +# link: +# type: generated-index +# title: Configuration overview \ No newline at end of file diff --git a/website/docs/dictionaries/_category_.yaml b/website/docs/dictionaries/_category_.yaml new file mode 100644 index 00000000000..7d56a6cafff --- /dev/null +++ b/website/docs/dictionaries/_category_.yaml @@ -0,0 +1,7 @@ +position: 4 +label: 'Dictionaries' +collapsible: true # make the category collapsible +collapsed: false # keep the category open by default +# link: +# type: generated-index +# title: Dictionaries overview \ No newline at end of file diff --git a/website/docs/dictionaries-custom.md b/website/docs/dictionaries/custom-dictionaries.md similarity index 97% rename from website/docs/dictionaries-custom.md rename to website/docs/dictionaries/custom-dictionaries.md index d0f0f21ad01..8c8d4b0c240 100644 --- a/website/docs/dictionaries-custom.md +++ b/website/docs/dictionaries/custom-dictionaries.md @@ -3,7 +3,8 @@ layout: default title: Custom Dictionaries categories: docs # parent: Docs -nav_order: 4 +sidebar_position: 2 +sidebar_label: Custom Dictionaries --- # Custom Dictionaries diff --git a/website/docs/dictionaries.md b/website/docs/dictionaries/index.md similarity index 98% rename from website/docs/dictionaries.md rename to website/docs/dictionaries/index.md index c2c2817a8c5..f608e842fae 100644 --- a/website/docs/dictionaries.md +++ b/website/docs/dictionaries/index.md @@ -3,7 +3,8 @@ layout: default title: Dictionaries categories: docs # parent: Docs -nav_order: 4 +sidebar_position: 1 +sidebar_label: Default Dictionaries --- # Dictionaries diff --git a/website/docs/command-trace.md b/website/docs/dictionaries/searching-dictionaries.md similarity index 97% rename from website/docs/command-trace.md rename to website/docs/dictionaries/searching-dictionaries.md index 669f8d86553..9fb9a265d84 100644 --- a/website/docs/command-trace.md +++ b/website/docs/dictionaries/searching-dictionaries.md @@ -2,7 +2,8 @@ title: 'Searching Dictionaries' categories: docs # parent: Docs -nav_order: 4 +sidebar_position: 3 +sidebar_label: Searching Dictionaries --- # Searching Dictionaries diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index d6df12501ce..b6d60b1f71b 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -2,7 +2,8 @@ title: 'Getting Started with CSpell' categories: docs # parent: Docs -nav_order: 2 +sidebar_position: 1 +sidebar_label: Getting Started --- # Spell Checking diff --git a/website/docs/installation.md b/website/docs/installation.md index a9ebe6e0fa2..0853fabf22d 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -2,7 +2,8 @@ title: 'Installing CSpell' categories: docs # parent: Docs -nav_order: 2 +sidebar_position: 2 +sidebar_label: Installation --- # Installation diff --git a/website/src/css/custom.css b/website/src/css/custom.css index f736f2dfc84..598abc56224 100644 --- a/website/src/css/custom.css +++ b/website/src/css/custom.css @@ -40,6 +40,10 @@ background-color: #242526; } */ +.navbar__logo { + display: none; +} + h1.hero__title { color: var(--ifm-color-primary); } From 8244f5b8c53b6035c6c12074bbaebf843d96f11d Mon Sep 17 00:00:00 2001 From: Felix Moeser Date: Fri, 10 May 2024 17:11:47 +0200 Subject: [PATCH 2/3] Update broken links --- website/docs/dictionaries/index.md | 2 +- website/docs/getting-started.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/website/docs/dictionaries/index.md b/website/docs/dictionaries/index.md index f608e842fae..3d91e7e987c 100644 --- a/website/docs/dictionaries/index.md +++ b/website/docs/dictionaries/index.md @@ -11,7 +11,7 @@ sidebar_label: Default Dictionaries The spell checker includes a set of default dictionaries. -Use the `trace` command to see a list of dictionaries: See [Searching Dictionaries](./command-trace.md) +Use the `trace` command to see a list of dictionaries: See [Searching Dictionaries](./dictionaries/searching-dictionaries) ## General Dictionaries diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index b6d60b1f71b..066cda853f4 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -138,8 +138,8 @@ Steps: The following resources can help you with fine-tuning your configurations: - [Making words forbidden](./forbidden-words.md) -- [Defining Custom Dictionaries](./dictionaries-custom.md) -- [About Dictionaries](./dictionaries.md) +- [Defining Custom Dictionaries](./dictionaries/custom-dictionaries) +- [About Dictionaries](./dictionaries) - [Understanding CSpell Globs](./globs.md) # Help From 3c576ee8cca289bc1699e6f5d886f472131eb6e5 Mon Sep 17 00:00:00 2001 From: Felix Moeser Date: Fri, 10 May 2024 17:20:29 +0200 Subject: [PATCH 3/3] Fix --- website/docs/how-it-works.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/docs/how-it-works.md b/website/docs/how-it-works.md index f6b73c8c58d..1b1bca60449 100644 --- a/website/docs/how-it-works.md +++ b/website/docs/how-it-works.md @@ -36,7 +36,7 @@ The concept is simple, split camelCase and snake_case words before checking them ## Dictionaries -See also: [Dictionaries](./dictionaries.md) and [Custom Dictionaries](./dictionaries-custom.md) +See also: [Dictionaries](./dictionaries) and [Custom Dictionaries](./dictionaries/custom-dictionaries) The _dictionaries_ list allows you to specify dictionaries to use for the file.