My real case Migrate repository from BitBucket to GitHub. I could delete Commit histories. What I’ve done Update .gitignore. Delete docs directory. Update netlify.toml [build] publish = "docs" command = "hugo --gc --minify" [context.production.environment] HUGO_VERSION = "0.87.0" rm -rf data #old dir structure rm -rf .git rm -rf theme/mainroad git init git submodule add git@github.com:Vimux/Mainroad.git themes/mainroad git config --global user.name atlex00 git config --global user.email ... git commit git push origin master --force
Render static images Place your image file under static directory. E.g., static/cat1/my_image.png. Refer the image without static. e.g., /cat1/my_image.png.  Add captions Using Markdown render hooks The main idea is, we can overwrite how to convert image lines in markdown into HTML by create the template file layouts/_default/_markup/render-image.html.
I copied the logic from this page (Thank you, Sebastian!)
If title is specified, render by <figcaption> tag.
Motivation To enable TikZ in my note, I add a header in layout/partial/header.html at first. But this change injects the javascript lines into all my posts which don’t need to include the TikZ. So I want to inject JavaScript in case that I mark the post as “TikZ enabled”.
How to Create a HTML template In layouts/partials/header.html.
{{ if and .IsPage (eq (.Param "tikz") true) }} <link rel="stylesheet" type="text/css" href="https://tikzjax.com/v1/fonts.css"> <script src="https://tikzjax.
The theme - Learn https://themes.gohugo.io/hugo-theme-learn/
When is it good? Write about a theme.
hugo new site spec_page cd spec_page git init git submodule add https://github.com/matcornic/hugo-theme-learn.git themes/hugo-theme-learn echo "theme = \"hugo-theme-learn\"" >> config.toml hugo new general/test.md Memo: Your personal page https://github.com/gcushen/hugo-academic
https://gohugo.io/content-management/cross-references/#use-ref-and-relref
Refer another post Please delete a backquote (\) in the follwoing snippet. I added it because of a Hugo rendering issue.
[text to be hyperlinked]({\{< ref "hugo/article.md" >}}) You don’t need to append contents in the reference.
When you open this hugo document in local hugo server the link is referred as http://localhost:1313/hugo/article. When you open this hugo document on the hosted server, the link is referred as http://{{ your_base_URL_in_config.
Enabling TOC Here is the official document about TOC.
When you want to enabling TOC feature in Hugo, add the following line in config.toml. Then, TOC will enabled at all posts.
[Params] ... toc = true ... Configure TOC Here is the official document about TOC configurations.
I don’t need to configure it detail enough, added the disription in config.toml.
[markup] [markup.tableOfContents] startLevel = 2 endLevel = 4 ordered = false startLevel = 1: List to the TOC from #.
I think my solution here is not the best way to use Mermaid in Hugo.
What is Mermaid? Mermaid is a sequence diagram generator written in Javascript.
https://github.com/mermaid-js/mermaid
Not only sequence diagrams, Mermaid can also generate simple graphs.
Enabling Mermaid in Hugo - use mermaid-cli Failures I tried two patterns but I failed both cases.
Make a template in the theme Mainroad. I’ve Tried to copy MathJax template but failed. But this is the simplest and useful, so I need to study Hugo more.
Tips - Change the template which generated by hugo new You can define a template in the file archetypes/default.md.
Here is my sample.
--- title: "{{ replace .Name "-" " " | title }}" date: {{ .Date }} categories: - "Draft" tags: - "dummy_tag" isCKJLanguage: false mathjax: false comments: false draft: true ---
Most of the information on this page is in the official document.
https://themes.gohugo.io/mainroad/
This post is a personal memo to remind me of what I did.
Main page It “specifies section pages to show on home page and the “Recent articles” widget.” The following config line shows content/general and content/hugo category on our main page.
[Params] mainSections = ["general", "hugo"] Add Google Analytics Mainroad theme supports Google Analytics as default, so you don’t need to input the JavaScript in the template manually.
Highlight codes in Hugo - It’s changed Old Hugo Around a year ago (2019), we need to configure pygments in order to highlight codes in code block. Here are sample lines in config.toml file.
... pygmentsCodefences = true pygmentsCodefencesGuessSyntax = true pygmentsStyle = "monokai" ... Latest Hugo (2020) At the new version Hugo in 2020, Hugo officially supports code highlight as a default as a default.
Official syntax highlighting: https://gohugo.io/content-management/syntax-highlighting/#highlighting-in-code-fences