mirror of
https://github.com/imfing/hextra.git
synced 2025-07-01 22:17:17 -04:00
chore: add example sidebar data file
- update docs - replace original sidebar template with new sidebar template - update references names
This commit is contained in:
Xin
@ -87,7 +87,7 @@ params:
|
||||
|
||||
### Main Sidebar
|
||||
|
||||
For the main sidebar, it is automatically generated from the structure of the content directory.
|
||||
By default, the main sidebar is automatically generated from the structure of the content directory.
|
||||
See the [Organize Files](/docs/guide/organize-files) page for more details.
|
||||
|
||||
To exclude a single page from the left sidebar, set the `sidebar.exclude` parameter in the front matter of the page:
|
||||
@ -119,6 +119,33 @@ menu:
|
||||
weight: 3
|
||||
```
|
||||
|
||||
### Sidebar from Data
|
||||
|
||||
Alternatively, you can define the sidebar structure in the `data` directory. This gives you more flexibility to define sidebar differently than your content structure. To enable this, set the `params.sidebar.source` parameter in the config file to `data`:
|
||||
|
||||
```yaml {filename="hugo.yaml"}
|
||||
params:
|
||||
sidebar:
|
||||
source: data
|
||||
```
|
||||
|
||||
To define the sidebar data, create a file named `sidebar.yaml` in the `data` directory.
|
||||
|
||||
```yaml {filename="data/sidebar.yaml"}
|
||||
docs:
|
||||
- title: Documentation
|
||||
link: /docs/
|
||||
- title: Guide
|
||||
link: /docs/guide/
|
||||
open: false
|
||||
items:
|
||||
- title: Configuration
|
||||
link: /docs/guide/configuration/
|
||||
# ...
|
||||
```
|
||||
|
||||
If your site is multilingual, you can define the sidebar data for each language, for example in `data/en/sidebar.yaml` file.
|
||||
|
||||
## Right Sidebar
|
||||
|
||||
### Table of Contents
|
||||
|
||||
49
exampleSite/data/en/sidebar.yaml
Normal file
49
exampleSite/data/en/sidebar.yaml
Normal file
@ -0,0 +1,49 @@
|
||||
docs:
|
||||
- title: Documentation
|
||||
link: /docs/
|
||||
- title: Getting Started
|
||||
link: /docs/getting-started/
|
||||
- title: Guide
|
||||
link: /docs/guide/
|
||||
open: false
|
||||
items:
|
||||
- title: Organize Files
|
||||
link: /docs/guide/organize-files/
|
||||
- title: Configuration
|
||||
link: /docs/guide/configuration/
|
||||
- title: Markdown
|
||||
link: /docs/guide/markdown/
|
||||
- title: Syntax Highlighting
|
||||
link: /docs/guide/syntax-highlighting/
|
||||
- title: LaTeX
|
||||
link: /docs/guide/latex/
|
||||
- title: Diagrams
|
||||
link: /docs/guide/diagrams/
|
||||
- title: Shortcodes
|
||||
link: /docs/guide/shortcodes/
|
||||
items:
|
||||
- title: Callout
|
||||
link: /docs/guide/shortcodes/callout/
|
||||
- title: Cards
|
||||
link: /docs/guide/shortcodes/cards/
|
||||
- title: Details
|
||||
link: /docs/guide/shortcodes/details/
|
||||
- title: FileTree
|
||||
link: /docs/guide/shortcodes/filetree/
|
||||
- title: Icon
|
||||
link: /docs/guide/shortcodes/icon/
|
||||
- title: Steps
|
||||
link: /docs/guide/shortcodes/steps/
|
||||
- title: Tabs
|
||||
link: /docs/guide/shortcodes/tabs/
|
||||
- title: Deploy Site
|
||||
link: /docs/guide/deploy-site/
|
||||
- title: Advanced
|
||||
link: /docs/advanced/
|
||||
items:
|
||||
- title: Multi-language
|
||||
link: /docs/advanced/multi-language/
|
||||
- title: Comments
|
||||
link: /docs/advanced/comments/
|
||||
- title: Customization
|
||||
link: /docs/advanced/customization/
|
||||
@ -113,6 +113,10 @@ params:
|
||||
# full (100%), wide (90rem), normal (1280px)
|
||||
width: normal
|
||||
|
||||
# TODO: move one level up
|
||||
sidebar:
|
||||
source: data
|
||||
|
||||
theme:
|
||||
# light | dark | system
|
||||
default: system
|
||||
|
||||
@ -76,40 +76,29 @@
|
||||
"active:hx-shadow-sm",
|
||||
"before:hx-absolute",
|
||||
"before:hx-bg-glass-gradient",
|
||||
"before:hx-bg-gray-200",
|
||||
"before:hx-content-[\"\"]",
|
||||
"before:hx-content-['#']",
|
||||
"before:hx-content-['']",
|
||||
"before:hx-inline-block",
|
||||
"before:hx-inset-0",
|
||||
"before:hx-inset-y-1",
|
||||
"before:hx-mr-1",
|
||||
"before:hx-opacity-25",
|
||||
"before:hx-pointer-events-none",
|
||||
"before:hx-transition-transform",
|
||||
"before:hx-w-px",
|
||||
"chroma",
|
||||
"content",
|
||||
"contrast-more:dark:hover:hx-border-gray-50",
|
||||
"contrast-more:dark:hx-border-current",
|
||||
"contrast-more:dark:hx-border-gray-50",
|
||||
"contrast-more:dark:hx-border-neutral-400",
|
||||
"contrast-more:dark:hx-border-primary-500",
|
||||
"contrast-more:dark:hx-shadow-[0_0_0_1px_#fff]",
|
||||
"contrast-more:dark:hx-shadow-none",
|
||||
"contrast-more:dark:hx-text-current",
|
||||
"contrast-more:dark:hx-text-gray-100",
|
||||
"contrast-more:dark:hx-text-gray-300",
|
||||
"contrast-more:dark:hx-text-gray-50",
|
||||
"contrast-more:hover:hx-border-gray-900",
|
||||
"contrast-more:hx-border",
|
||||
"contrast-more:hx-border-current",
|
||||
"contrast-more:hx-border-gray-800",
|
||||
"contrast-more:hx-border-gray-900",
|
||||
"contrast-more:hx-border-neutral-400",
|
||||
"contrast-more:hx-border-primary-500",
|
||||
"contrast-more:hx-border-t",
|
||||
"contrast-more:hx-border-transparent",
|
||||
"contrast-more:hx-font-bold",
|
||||
"contrast-more:hx-shadow-[0_0_0_1px_#000]",
|
||||
"contrast-more:hx-shadow-none",
|
||||
@ -119,7 +108,6 @@
|
||||
"contrast-more:hx-text-gray-900",
|
||||
"contrast-more:hx-underline",
|
||||
"copy-icon",
|
||||
"dark:before:hx-bg-neutral-800",
|
||||
"dark:before:hx-invert",
|
||||
"dark:contrast-more:hx-border-neutral-400",
|
||||
"dark:focus:hx-bg-dark",
|
||||
@ -154,7 +142,6 @@
|
||||
"dark:hx-bg-neutral-900",
|
||||
"dark:hx-bg-orange-400/20",
|
||||
"dark:hx-bg-primary-300/10",
|
||||
"dark:hx-bg-primary-400/10",
|
||||
"dark:hx-bg-primary-600",
|
||||
"dark:hx-bg-red-900/30",
|
||||
"dark:hx-bg-yellow-700/30",
|
||||
@ -188,9 +175,7 @@
|
||||
"dark:hx-text-green-200",
|
||||
"dark:hx-text-indigo-200",
|
||||
"dark:hx-text-neutral-200",
|
||||
"dark:hx-text-neutral-400",
|
||||
"dark:hx-text-orange-300",
|
||||
"dark:hx-text-primary-600",
|
||||
"dark:hx-text-red-200",
|
||||
"dark:hx-text-slate-100",
|
||||
"dark:hx-text-yellow-200",
|
||||
@ -288,7 +273,6 @@
|
||||
"hx-bg-indigo-100",
|
||||
"hx-bg-neutral-50",
|
||||
"hx-bg-orange-50",
|
||||
"hx-bg-primary-100",
|
||||
"hx-bg-primary-400",
|
||||
"hx-bg-primary-600",
|
||||
"hx-bg-primary-700/5",
|
||||
@ -360,7 +344,6 @@
|
||||
"hx-inset-y-0",
|
||||
"hx-items-center",
|
||||
"hx-items-start",
|
||||
"hx-justify-between",
|
||||
"hx-justify-center",
|
||||
"hx-justify-end",
|
||||
"hx-justify-items-start",
|
||||
@ -509,7 +492,6 @@
|
||||
"hx-text-left",
|
||||
"hx-text-lg",
|
||||
"hx-text-orange-800",
|
||||
"hx-text-primary-800",
|
||||
"hx-text-red-900",
|
||||
"hx-text-slate-900",
|
||||
"hx-text-sm",
|
||||
@ -553,11 +535,9 @@
|
||||
"last-of-type:hx-mb-0",
|
||||
"lntable",
|
||||
"lntd",
|
||||
"ltr:before:hx-left-0",
|
||||
"ltr:hx--mr-4",
|
||||
"ltr:hx-border-l",
|
||||
"ltr:hx-ml-1",
|
||||
"ltr:hx-ml-3",
|
||||
"ltr:hx-ml-auto",
|
||||
"ltr:hx-mr-auto",
|
||||
"ltr:hx-pl-12",
|
||||
@ -609,7 +589,6 @@
|
||||
"print:hx-bg-transparent",
|
||||
"print:hx-hidden",
|
||||
"rtl:-hx-rotate-180",
|
||||
"rtl:before:hx-right-0",
|
||||
"rtl:before:hx-rotate-180",
|
||||
"rtl:hx--ml-4",
|
||||
"rtl:hx-border-r",
|
||||
@ -617,7 +596,6 @@
|
||||
"rtl:hx-left-3",
|
||||
"rtl:hx-ml-auto",
|
||||
"rtl:hx-mr-1",
|
||||
"rtl:hx-mr-3",
|
||||
"rtl:hx-mr-auto",
|
||||
"rtl:hx-pl-2",
|
||||
"rtl:hx-pl-4",
|
||||
@ -634,8 +612,6 @@
|
||||
"search-input",
|
||||
"search-results",
|
||||
"search-wrapper",
|
||||
"sidebar-active-item",
|
||||
"sidebar-container",
|
||||
"sm:hx-block",
|
||||
"sm:hx-flex",
|
||||
"sm:hx-items-start",
|
||||
|
||||
Reference in New Issue
Block a user