/math/etc/

Navigation

 
  • Feb 27, 2024

There are two types of navigation in TeXt: Header Navigation and Sidebar Navigation, both are defined in data/navigation.yml.

Header Navigation

Header navigation is defined under the header key in data/navigation.yml, it is an array of title(s) and url:

header:
  - title:      Docs
    url:        /docs/en/quick-start
  - title:      文档
    url:        /docs/zh/quick-start
  - titles:
      en:       Archive
      zh:       归档
      zh-Hans:  归档
      zh-Hant:  歸檔
    url:        /archive.html
  - titles:
      en:       About
      zh:       关于
      zh-Hans:  关于
      zh-Hant:  關於
    url:        /about.html
  - title:      GitHub
    url:        https://github.com/kitian616/jekyll-TeXt-theme

You can use titles for a multi-language name.

To use sidebar navigation, you should first define a navigation in data/navigation.yml.

docs-en:
  - title:      Start
    children:
      - title:  Quick Start
        url:    /docs/en/quick-start
      - title:  Structure
        url:    /docs/en/structure
      ...
  - title:      Customization
    children:
      - title:  Configuration
        url:    /docs/en/configuration
      - title:  Navigation
        url:    /docs/en/navigation
      ...

And then use the defined navigation as article’s sidebar navigation in the Front Matter:

sidebar:
  nav: docs-en