PATH. Attention: Use the extended version: e.g.
yarnonce (this will install required css and js packages)
As you make modifications to the site it will be rebuild and the page in the browser gets reloaded.
hugo new you can create a new page with the correct frontmatter for that kind of page:
content/and determines the URL of the page
Or you can simply create a new
.pandoc-file in the correct location and fill it by yourself.
The are submenus (shown in the left sidebar) for specific sections such as for benchmarks. The submenus consist of groups (e.g. Elliptic) and page entries. Groups are defined in
[[menu.benchmarks]] name = "Elliptic" identifier = "elliptic" weight = 1
To add your page to a group as an entry add the following frontmatter:
weight = 101 [menu] [menu.benchmarks] parent = "elliptic"
weight specifies the order of groups and pages in ascending order (top -> down).
We use Pandoc Markdown for the actual content.
It is an enhanced version of the original Markdown. Please consult both guides!
Use regular Markdown syntax:
The path to the image can be absolute (by preceding with
/) or relative. The relative path starts at your current URL. If your image is in the same directory as your
.pandoc-file you have to prefix your path with
../ as in the example above.
See the Pandoc Help for more options on e.g. image size and captions.
Equations can be set with typical LaTeX syntax by using MathJax. Blocks are defined by
$$ at the beginning and
$$ at the end of the block. Inline math uses one
$ as the delimiter. For more usage instructions see the MathJax LaTeX help.
Files belonging directly to a page (e.g. images shown on that same page) should be added directly (they are stored by git lfs). Other stuff such as linked PDF files, book chapter input files should be uploaded elsewhere and linked to. You can ask @bilke to host these files for you (on Azure cloud storage).
Bibliography items from Documentation/bibliography.bib can be referenced by their id with the
The bib-file has to be converted into a json-file with the pandoc-citeproc-tool:
This json-file is then used by the shortcode.
npm install -g @hashicorp/broken-links-checker hugo broken-links-checker --path ./public --baseUrl https://www.opengeosys.org