nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-01-18 19:00:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
A theme for Hugo designed for documentation
48 commits 3 branches 220 tags 602 MiB
JavaScript 97.7%
CSS 1.3%
HTML 0.9%
Find a file
Leclerc Gwendal 102b4cea8d feat: add search section into the README.md
2016-10-25 20:26:19 +02:00
archetypes feat: partials for style and scripts are now empty 2016-04-11 00:09:03 +02:00
images feat: add screenshot and thumbnail images 2016-04-12 02:46:40 +02:00
layouts feat: configure lunr, extract inline javascript in search.js and fix horsey popup position 2016-10-25 20:26:19 +02:00
static feat: configure lunr, extract inline javascript in search.js and fix horsey popup position 2016-10-25 20:26:19 +02:00
.gitignore feat: added .gitignore 2016-03-17 12:03:28 +01:00
LICENSE.md feat: add screenshot and thumbnail images 2016-04-12 02:46:40 +02:00
README.md feat: add search section into the README.md 2016-10-25 20:26:19 +02:00
theme.toml Min 0.15 version is not enough anymore (see #7) 2016-10-23 19:09:32 +02:00

README.md

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