update Readme, added mermaid sample
This commit is contained in:
parent
2f20a8f927
commit
9d17471686
34
README.md
34
README.md
|
@ -1,30 +1,56 @@
|
|||
# Theme Name
|
||||
# Theme hugo-theme-fha
|
||||
|
||||
## Features
|
||||
|
||||
### Search
|
||||
Lightweight search functionality based on index file.
|
||||
Requires
|
||||
```toml
|
||||
[outputs]
|
||||
home = ["HTML", "RSS", "JSON"]
|
||||
```
|
||||
|
||||
### Mermaid
|
||||
Support for Mermaid schemas.
|
||||
|
||||
### Photos
|
||||
### Photos (soon)
|
||||
Support photos albums based on Folders.
|
||||
|
||||
### Syntax Hightlighting
|
||||
Required configuration to copy paste code :
|
||||
```toml
|
||||
[markup.highlight]
|
||||
lineNos=true
|
||||
lineNumbersInTable=true
|
||||
noClasses = false
|
||||
|
||||
```
|
||||
|
||||
### Curriculum Vitae
|
||||
Copy /layouts/section/cv.html to you local /layouts/section folder and edited the content.
|
||||
Save your own picture under /static/img/avatar.jpeg
|
||||
|
||||
Add an entry in the about Menu:
|
||||
|
||||
```toml
|
||||
[[menu.nav]]
|
||||
name = 'About'
|
||||
pageRef = '/about'
|
||||
weight = 100
|
||||
[[menu.nav]]
|
||||
identifier = "pAbout"
|
||||
name = "About"
|
||||
url = "/about"
|
||||
parent = "About"
|
||||
weight = 10
|
||||
[[menu.nav]]
|
||||
identifier = "pCv"
|
||||
name = "CV"
|
||||
url = "/cv"
|
||||
parent = "About"
|
||||
weight = 20
|
||||
```
|
||||
It is possible to add cv in other languages
|
||||
* Add the content is section (ex:cvfr.html).
|
||||
* Add an entry in the nav menu.
|
||||
|
||||
## Installation
|
||||
|
||||
|
|
|
@ -7,4 +7,15 @@ tags = ['red','green']
|
|||
|
||||
Anim eiusmod irure incididunt sint cupidatat. Incididunt irure irure irure nisi ipsum do ut quis fugiat consectetur proident cupidatat incididunt cillum. Dolore voluptate occaecat qui mollit laborum ullamco et. Ipsum laboris officia anim laboris culpa eiusmod ex magna ex cupidatat anim ipsum aute. Mollit aliquip occaecat qui sunt velit ut cupidatat reprehenderit enim sunt laborum. Velit veniam in officia nulla adipisicing ut duis officia.
|
||||
|
||||
```mermaid
|
||||
gantt
|
||||
title A Gantt Diagram
|
||||
dateFormat YYYY-MM-DD
|
||||
section Section
|
||||
A task :a1, 2014-01-01, 30d
|
||||
Another task :after a1, 20d
|
||||
section Another
|
||||
Task in Another :2014-01-12, 12d
|
||||
another task :24d
|
||||
```
|
||||
Exercitation voluptate irure in irure tempor mollit Lorem nostrud ad officia. Velit id fugiat occaecat do tempor. Sit officia Lorem aliquip eu deserunt consectetur. Aute proident deserunt in nulla aliquip dolore ipsum Lorem ut cupidatat consectetur sit sint laborum. Esse cupidatat sit sint sunt tempor exercitation deserunt. Labore dolor duis laborum est do nisi ut veniam dolor et nostrud nostrud.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
name = 'Fha Theme'
|
||||
name = 'Fha Theme : hugo-theme-fha'
|
||||
license = 'MIT'
|
||||
licenselink = 'https://github.com/owner/repo/LICENSE'
|
||||
licenselink = 'https://git.fhahome.dev/Template/hugo-theme-fha/LICENSE'
|
||||
description = 'A simple theme used for blogging, portfolio and documenting. Based on Bootstrap. '
|
||||
|
||||
# The home page of the theme, where the source can be found
|
||||
|
|
Loading…
Reference in New Issue