nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2024-10-27 02:33:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
hugo-theme-relearn/README.md
Leclerc Gwendal 102b4cea8d feat: add search section into the README.md
2016-10-25 20:26:19 +02:00

1.7 KiB
Raw Blame History

Hugo Learn Theme

This repository contains a theme for Hugo, based on great Grav Learn Theme.

Visit the theme documentation to see what is going on. It is actually built with this theme.

Installation

Navigate to your themes folder in your Hugo site and use the following commands:

$ cd themes
$ git clone https://github.com/matcornic/hugo-theme-learn.git

Overview

Main functionalities

  • Handle two levels of documentation
  • Tip/Note/Info and Warning boxes
  • Resize images
  • Preview of original image size
  • Add shadow or border on images
  • Automatic table of contents
  • Create buttons (typically used to provide a link to a demo)

Search

To use the search functionality, you just have to put a lunr index which respects this format :

[
    {
        "uri": "/docs/01-start/index",
        "title": "Get started",
        "content": "\n\nGet started\n\nAll you need to know...\n",
        "tags": ["start", "intro"]
    },
    ...
]

into a static/json/search.json file in your hugo project.

And set search = true in your config.toml

To generate your lunr index, you can see this project https://github.com/gwleclerc/lunr-hugo which parse your markdown files and extract toml and yaml headers to create index with corresponding format.

TODO