ViMaSter/hackertours-theme
Watch
0
0
Fork
You've already forked hackertours-theme
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README code lang formatting.

Browse source
This commit is contained in:
Fredrik Jonsson 2022-06-03 09:58:41 +02:00
commit 2c9feecc71
1 changed files with 11 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -194,7 +194,7 @@ Some performance tools will complain about to many files (js and css files are n
Configurations parameters for the sites config file, in yaml format. All the "params" are optional. Configurations parameters for the sites config file, in yaml format. All the "params" are optional.
``` ```yaml
baseurl: "https://example.org/" baseurl: "https://example.org/"
title: "SiteTitle" title: "SiteTitle"
theme: "zen" theme: "zen"
@ -358,7 +358,7 @@ For "rtl" languages add a `languageDirection` parameter to the language configur
Add a `languageCode` parameter to each language as well, that is used to set the correct language attribute in the `html` tag and in feeds. The root `languageCode` is then not needed. If not set the language key (e.g. "en") will be used. Add a `languageCode` parameter to each language as well, that is used to set the correct language attribute in the `html` tag and in feeds. The root `languageCode` is then not needed. If not set the language key (e.g. "en") will be used.
``` ```yaml
languages: languages:
sv: sv:
weight: 1 weight: 1
@ -383,7 +383,7 @@ Set `defaultContentLanguage` to your language code, otherwise it will default to
Here how it looks for a site in Swedish. Here how it looks for a site in Swedish.
``` ```yaml
languageCode: "sv-SE" languageCode: "sv-SE"
defaultContentLanguage: "sv" defaultContentLanguage: "sv"
``` ```
@ -396,7 +396,7 @@ Built in integration with the excellent [FlexSearch.js](https://github.com/nexta
Here is the three steps needed to create a search page. Here is the three steps needed to create a search page.
1. Add a new output format in your configuration file. 1. Add a new output format in your configuration file.
``` ```yaml
outputFormats: outputFormats:
SearchIndex: SearchIndex:
mediaType: "application/json" mediaType: "application/json"
@ -405,7 +405,7 @@ Here is the three steps needed to create a search page.
notAlternative: true notAlternative: true
``` ```
2. Add the new output format to output setting for "home". 2. Add the new output format to output setting for "home".
``` ```yaml
outputs: outputs:
home: ["HTML", "SearchIndex", "[other formats you need]"] home: ["HTML", "SearchIndex", "[other formats you need]"]
``` ```
@ -460,7 +460,7 @@ The Zen theme supports podcasting.
Here follow all the possible podcast frontmatter parameters. Only the first two is mandatory and are in the podcast archetype. Here follow all the possible podcast frontmatter parameters. Only the first two is mandatory and are in the podcast archetype.
``` ```yaml
podcast: podcast:
mp3: # * The path to the mp3 file, mp3: # * The path to the mp3 file,
duration: # * Episode duration, e.g 1:04:02 (iTunes). duration: # * Episode duration, e.g 1:04:02 (iTunes).
@ -608,7 +608,7 @@ Creates a link to an internal page.
This will output: This will output:
``` ```html
<a href="/path/to/page/">The title of the page</a> <a href="/path/to/page/">The title of the page</a>
``` ```
@ -657,7 +657,7 @@ Some more content.
This will produce: This will produce:
``` ```html
<div class="class-name-you-want"> <div class="class-name-you-want">
<p>The <strong>content</strong> that should be wrapped.</p> <p>The <strong>content</strong> that should be wrapped.</p>
@ -677,7 +677,7 @@ Some more content.
This will produce: This will produce:
``` ```html
<div class="class-name-you-want"> <div class="class-name-you-want">
The **content** that should be wrapped. Some more content. The **content** that should be wrapped. Some more content.
</div> </div>
@ -696,7 +696,7 @@ This is the way I construct my JavaScript files.
**Umbrella JS:** **Umbrella JS:**
``` ```js
(function ($) { (function ($) {
'use strict'; 'use strict';
@ -709,7 +709,7 @@ This is the way I construct my JavaScript files.
**jQuery:** **jQuery:**
``` ```js
(function ($) { (function ($) {
'use strict'; 'use strict';