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

docs: Navbar structure #5600

Merged
merged 3 commits into from
May 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion website/docs/Configuration/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: Configuration
nav_order: 4
description: 'Customizing CSpell'
has_children: true
---
Expand Down
7 changes: 7 additions & 0 deletions website/docs/configuration/_category_.yaml
Original file line number Diff line number Diff line change
@@ -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
7 changes: 7 additions & 0 deletions website/docs/dictionaries/_category_.yaml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,15 @@ layout: default
title: Dictionaries
categories: docs
# parent: Docs
nav_order: 4
sidebar_position: 1
sidebar_label: Default Dictionaries
---

# 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: 'Searching Dictionaries'
categories: docs
# parent: Docs
nav_order: 4
sidebar_position: 3
sidebar_label: Searching Dictionaries
---

# Searching Dictionaries
Expand Down
7 changes: 4 additions & 3 deletions website/docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -137,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
Expand Down
2 changes: 1 addition & 1 deletion website/docs/how-it-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion website/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
title: 'Installing CSpell'
categories: docs
# parent: Docs
nav_order: 2
sidebar_position: 2
sidebar_label: Installation
---

# Installation
Expand Down
4 changes: 4 additions & 0 deletions website/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,10 @@
background-color: #242526;
} */

.navbar__logo {
display: none;
}

h1.hero__title {
color: var(--ifm-color-primary);
}
Expand Down
Loading