diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 61 |
1 files changed, 49 insertions, 12 deletions
@@ -29,21 +29,60 @@ For more information read the official [setup guide](https://gohugo.io/overview/ ## Getting started -After installing the theme successfully it requires a just a few more steps to get your site running. - -### The config file - Copy the ```config.toml``` in the ```exampleSite```to the root of your Hugo site. Change strings as you like. -### Local preview - -In order to see your site in action, run Hugo's built-in local server: +Run Hugo's built-in local server: ```bash $ hugo server ``` -Now enter [```localhost:1313```](http://localhost:1313) in the address bar of your browser. +If you want to generate your site, just run ```hugo``` or ```hugo --minify```. + +## Advance configration + +### In-post license + +You can set variables below in post's front matter to disable it: + +```toml +noLicense = true # Do not show license in this post +``` + +### APlayer + +APlayer support both global left-bottom-fixed or in-post, you can set these variables in site's ```config.toml``` or in post's front matter: + +```toml +playerName = "..." # Audio title or name +playerArtist = "..." # Audio artist +playerURL = "..." # Audio URL, support aac, mp3, wav and ogg +playerCover = "..." # Audio cover +``` + +### Lazyload images + +Lazyload images in posts, for example in ```content/post/test.md```: + +```go-html-template +{{< lazyimg "This is alt text" "/img/sample.png" >}} +{{< lazyimg-row "This is alt text" "/img/sample.png" >}} +{{< lazyimg-col "This is alt text" "/img/sample.png" >}} +``` + +```lazyimg``` will show a 16x9 placeholder before image is loaded, so ```lazyimg-row``` will show a 32x9 placeholder and ```lazyimg-col``` will show a 8x9 placeholder. You can choose different aspect ratios you want for different images. The placeholder image can be set in site's ```config.toml```. + +Note that if you use the origin markdown syntax to add images such as ``````, it will not become a lazy image. + +### Markdown render hook + +You can create the files below in your site to adjust the markdown render hook, see [Hugo's Official Docs](https://gohugo.io/getting-started/configuration-markup#markdown-render-hooks). + +You can use ```layouts/_default/_markup/render-link.html``` to decide whether or not links in the markdown content will open in new tab: + +```html +<a href="{{ .Destination | safeURL }}"{{ with .Title }} title="{{ . }}"{{ end }}{{ if strings.HasPrefix .Destination "http" }} target="_blank"{{ end }}>{{ .Text | safeHTML }}</a> +``` ## Update the theme @@ -63,8 +102,6 @@ The theme is released under the ```GNU General Public License v3.0```, for more ## Annotations -Thanks to [ress](https://github.com/ress997/) for some great help. - -Thanks to [printempw](https://github.com/printempw/) for the idea of theme. +Thanks to [ress](https://github.com/ress997/) for some great help and [printempw](https://github.com/printempw/) for the origin idea of theme. -Thanks to developers for creating Hugo and the awesome community around the project. +Thanks to developers for creating Hugo, Primer CSS, Font Awesome, APlayer and Lazysizes with the awesome community around these project. |