Skip to content

Commit

Permalink
Search and documentation site builder has been updated
Browse files Browse the repository at this point in the history
  • Loading branch information
harrymkt authored Dec 28, 2024
1 parent d1e4fe1 commit 53d11be
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions demo/content/docs/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ layout: doc
# Documentation Site
Hguinav supports built-in documentation template that allows you to create list base documentation pages. Each section, starting at content/, you can create a subsection documentation. You can also look the docs folder of this theme demo.

**Note**: documentation uses both Weight and Title sort styles by default. Please note that when using weight, you also need to set for subsections.
**Note**: documentation uses both Weight and Title sort styles by default. Please note that when using weight, you also need to set for subsections. Remember that Hugo does not support sorting for specific section. As such, a custom [sort partial]({{% relref "partials/sort.md" %}}) is the actual work implemented in Hguinav.

## Setup
First, create first documentation section in content folder, and add _index.md to it containing the following frontmadder. For this documentation, we will create docs folder and use YAML for frontmadder.
First, create the documentation section in content folder, and add _index.md to it containing the following frontmadder. For this documentation, we will create docs folder and use YAML for frontmadder as this theme is YAML based.
```yaml
---
title: "Your Documentation Main Section's Title"
Expand Down
2 changes: 1 addition & 1 deletion demo/content/docs/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ layout: doc
Hguinav has search built-in. This is a quick overview on how to create your search.

## Configuration
These configurations apply on `params` object of the config. See [search configuration]({{% relref "params/config.md#search" %}}).
These configurations apply on `params` object of the config. See [search configuration]({{% relref "params/config.md#search" %}}) for more information and supported configuration options.

## Search Formats{#sformats}
### lunr
Expand Down

0 comments on commit 53d11be

Please sign in to comment.