# Default Theme Config

# Homepage

The default theme provides a homepage layout (used on the homepage of this site). To use it, specify home: true plus some other metadata in your root README.md's YAML frontmatter. This is an example of how it works:

---
home: true
heroImage: /hero.png
heroText: Hero Title
tagline: Hero subtitle
actionText: Get Started →
actionLink: /guide/
features:
- title: Simplicity First
  details: Minimal setup with markdown-centered project structure helps you focus on writing.
- title: Kdu-Powered
  details: Enjoy the dev experience of Kdu + webpack, use Kdu components in markdown, and develop custom themes with Kdu.
- title: Performant
  details: KduPress generates pre-rendered static HTML for each page, and runs as an SPA once a page is loaded.
footer: MIT Licensed | Copyright © 2021-present NKDuy
---

You can disable title and subtitle by setting the corresponding field to null.

Any extra content after the YAML front matter will be parsed as normal Markdown and rendered after the features section.

To use a fully custom homepage layout, you can also use a Custom Layout.

# Navbar

The Navbar may contain your page title, Search Box, Navbar Links, Languages and Repository Link, they all depend on your configuration.

# Navbar Logo

You can add a logo to the navbar via themeConfig.logo. Logo can be placed in public folder.

// .kdupress/config.js
module.exports = {
  themeConfig: {
    logo: '/assets/img/logo.png',
  }
}

# Navbar Links

You can add links to the navbar via themeConfig.nav:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    nav: [
      { text: 'Home', link: '/' },
      { text: 'Guide', link: '/guide/' },
      { text: 'External', link: 'https://google.com' }
    ]
  }
}

Outbound links automatically get target="_blank" rel="noopener noreferrer". You can offer target and rel to customize the attributes. Setting rel: false as will disable the rel attribute for a link:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    nav: [
      { text: 'External', link: 'https://google.com', target:'_self', rel:false },
      { text: 'Guide', link: '/guide/', target:'_blank' }
    ]
  }
}

These links can also be dropdown menus if you provide an array of items instead of a link:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    nav: [
      {
        text: 'Languages',
        ariaLabel: 'Language Menu',
        items: [
          { text: 'Vietnamese', link: '/language/vietnamese/' },
          { text: 'Japanese', link: '/language/japanese/' }
        ]
      }
    ]
  }
}

You can also have sub groups inside a dropdown by having nested items:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    nav: [
      {
        text: 'Languages',
        items: [
          { text: 'Group1', items: [/*  */] },
          { text: 'Group2', items: [/*  */] }
        ]
      }
    ]
  }
}

# Disable the Navbar

To disable the navbar globally, use themeConfig.navbar:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    navbar: false
  }
}

You can disable the navbar for a specific page via YAML front matter:

---
navbar: false
---

# Sidebar

To enable the sidebar, use themeConfig.sidebar. The basic configuration expects an Array of links:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    sidebar: [
      '/',
      '/page-a',
      ['/page-b', 'Explicit link text']
    ]
  }
}

You can omit the .md extension, and paths ending with / are inferred as */README.md. The text for the link is automatically inferred (either from the first header in the page or explicit title in YAML front matter). To explicitly specify the link text, use an array in form of [link, text].

# Nested Header Links

The sidebar automatically displays links for headers in the current active page, nested under the link for the page itself. You can customize this behavior using themeConfig.sidebarDepth. The default depth is 1, which extracts the h2 headers. Setting it to 0 disables the header links, and the max value is 2 which extracts both h2 and h3 headers.

A page can also override this value via YAML front matter:

---
sidebarDepth: 2
---

# Displaying Header Links of All Pages

The sidebar only displays links for headers in the current active page. You can display all header links for every page with themeConfig.displayAllHeaders: true:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    displayAllHeaders: true // Default: false
  }
}

# Active Header Links

By default, the nested header links and the hash in the URL are updated as the user scrolls to view the different sections of the page. This behavior can be disabled with the following theme config:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    activeHeaderLinks: false, // Default: true
  }
}

# Sidebar Groups

You can divide sidebar links into several groups by using objects:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    sidebar: [
      {
        title: 'Group 1',   // required
        path: '/foo/',      // optional, link of the title, which should be an absolute path and must exist
        collapsable: false, // optional, defaults to true
        sidebarDepth: 1,    // optional, defaults to 1
        children: [
          '/'
        ]
      },
      {
        title: 'Group 2',
        children: [ /* ... */ ],
        initialOpenGroupIndex: -1 // optional, defaults to 0, defines the index of initially opened subgroup
      }
    ]
  }
}

Sidebar groups are collapsable by default. You can force a group to be always open with collapsable: false.

A sidebar group config also supports sidebarDepth field to override the default sidebar depth (1).

# Multiple Sidebars

To display different sidebars for different sections of content, first organize your pages into directories for each desired section:

.
├─ README.md
├─ contact.md
├─ about.md
├─ foo/
│  ├─ README.md
│  ├─ one.md
│  └─ two.md
└─ bar/
   ├─ README.md
   ├─ three.md
   └─ four.md

Then, update your configuration to define your sidebar for each section.

// .kdupress/config.js
module.exports = {
  themeConfig: {
    sidebar: {
      '/foo/': [
        '',     /* /foo/ */
        'one',  /* /foo/one.html */
        'two'   /* /foo/two.html */
      ],

      '/bar/': [
        '',      /* /bar/ */
        'three', /* /bar/three.html */
        'four'   /* /bar/four.html */
      ],

      '/baz/': 'auto', /* automatically generate single-page sidebars */

      // fallback
      '/': [
        '',        /* / */
        'contact', /* /contact.html */
        'about'    /* /about.html */
      ]
    }
  }
}

# Auto Sidebar for Single Pages

To automatically generate a sidebar that contains only the header links for the current page, you can use YAML front matter on that page:

---
sidebar: auto
---

You can also enable it in all pages by using config:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    sidebar: 'auto'
  }
}

In multi-language mode, you can also apply it to a specific locale:

// .kdupress/config.js
module.exports = {
  themeConfig: {
     '/': {
       sidebar: 'auto'
     }
  }
}

# Disabling the Sidebar

You can disable the sidebar on a specific page with YAML front matter:

---
sidebar: false
---

# Search Box

# Built-in Search

You can disable the built-in search box with themeConfig.search: false, and customize how many suggestions will be shown with themeConfig.searchMaxSuggestions:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    search: false,
    searchMaxSuggestions: 10
  }
}

You can improve the search result by setting tags in frontmatter:

---
tags:
  - configuration
  - theme
  - indexing
---

You can also disable the built-in search box for individual pages by setting search in frontmatter:

---
search: false
---

# Algolia Search

The themeConfig.algolia option allows you to use Algolia DocSearch (opens new window) to replace the simple built-in search. To enable it, you need to provide at least apiKey and indexName:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    algolia: {
      apiKey: '<API_KEY>',
      indexName: '<INDEX_NAME>'
    }
  }
}

For more options, check out Algolia DocSearch’s documentation (opens new window).

# Search Placeholder

You can define a placeholder for the search box by adding the searchPlaceholder attribute:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    searchPlaceholder: 'Search...'
  }
}

# Last Updated

The themeConfig.lastUpdated option allows you to get the UNIX timestamp(ms) of each file’s last git commit, and it will also display at the bottom of each page in an appropriate format:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    lastUpdated: 'Last Updated', // string | boolean
  }
}

Note that it’s off by default. If given a string, it will be displayed as a prefix (default value: Last Updated).

Also see:

• @kdupress/plugin-last-updated

# Prev / Next Links

Prev and next links are automatically inferred based on the sidebar order of the active page.

You can disable them globally with themeConfig.nextLinks and themeConfig.prevLinks:

// .kdupress/config.js
module.exports = {
  themeConfig: {
    // default value is true. Set it to false to hide next page links on all pages
    nextLinks: false,
    // default value is true. Set it to false to hide prev page links on all pages
    prevLinks: false
  }
}

You can also explicitly overwrite or disable them for individual pages with YAML front matter:

---
prev: ./some-other-page
next: false
---

# Git repository and Edit Links

Providing themeConfig.repo auto generates a GitHub link in the navbar and "Edit this page" links at the bottom of each page.

// .kdupress/config.js
module.exports = {
  themeConfig: {
    // Assumes GitHub. Can also be a full GitLab url.
    repo: 'kdujs/kdupress',
    // Customising the header label
    // Defaults to "GitHub"/"GitLab"/"Bitbucket" depending on `themeConfig.repo`
    repoLabel: 'Contribute!',

    // Optional options for generating "Edit this page" link

    // if your docs are in a different repo from your main project:
    docsRepo: 'kdujs/kdupress',
    // if your docs are not at the root of the repo:
    docsDir: 'docs',
    // if your docs are in a specific branch (defaults to 'main'):
    docsBranch: 'main',
    // defaults to false, set to true to enable
    editLinks: true,
    // custom text for edit link. Defaults to "Edit this page"
    editLinkText: 'Help us improve this page!'
  }
}

You can overwrite the following properties on specific pages via YAML front matter:

---
editLink: false # Will overwrite 'editLinks' from themeConfig
prev: true # Will overwrite 'prevLinks' property from themeConfig
next: ./my-next-page # Will overwrite 'nextLinks' property from themeConfig
---

# Smooth Scrolling 1.2.0+

The themeConfig.smoothScroll option allows you to enable smooth scrolling.

// .kdupress/config.js
module.exports = {
  themeConfig: {
    smoothScroll: true
  }
}

# Custom Page Class

Sometimes, you may need to add a unique class for a specific page so that you can target content on that page only in custom CSS. You can add a class to the theme container div with pageClass in YAML front matter:

---
pageClass: custom-page-class
---

Then you can write CSS targeting that page only in ./kdupress/styles/index.styl.

.theme-container.custom-page-class {
  /* page-specific rules */
}

# Custom Layout for Specific Pages

By default the content of each *.md file is rendered in a <div class="page"> container, along with the sidebar, auto-generated edit links and prev/next links. To use a fully custom component in place of the page, you can again specify the component to use using YAML front matter:

---
layout: SpecialLayout
---

This will render .kdupress/components/SpecialLayout.kdu for the given page.

# Code Groups and Code Blocks 1.6.0+

The default theme comes with custom components <code-group /> and <code-block> that can help you to better group separate code paths that have the same result.

Example

Yarn and npm installation instructions

Input

<code-group>
<code-block title="YARN">
```bash
yarn create kdupress-site [optionalDirectoryName]
```
</code-block>

<code-block title="NPM">
```bash
npx create-kdupress-site [optionalDirectoryName]
```
</code-block>
</code-group>

Output

yarn create kdupress-site [optionalDirectoryName]

npx create-kdupress-site [optionalDirectoryName]

// Make sure to add code blocks to your code group

# Default Code Block

By default, <code-group /> will use the first <code-block /> as the active initial code block.

To manually set the active <code-block />, just add the active prop to the <code-block />:

Input

<code-group>
<code-block title="YARN">
```bash
yarn create kdupress-site [optionalDirectoryName]
```
</code-block>

<code-block title="NPM" active>
```bash
npx create-kdupress-site [optionalDirectoryName]
```
</code-block>
</code-group>

Output

yarn create kdupress-site [optionalDirectoryName]

npx create-kdupress-site [optionalDirectoryName]

// Make sure to add code blocks to your code group

# Ejecting

You can copy the default theme source code into .kdupress/theme to fully customize the theme using the kdupress eject [targetDir] command. If you didn’t install KduPress globally, run ./node_modules/.bin/kdupress eject.