Hugo
Contents
- Quick Reference
- Create a new single page
hugo new posts/a/index.mdindex.zh-cn.mdfor Chinese version
- Local preview at
localhost: 1313hugo server(-Dto include drafts)
- Update all submodules
git submodule initgit pull --recurse-submodulesorgit submodule update --remote --merge
- version
hugo versionshow current versionbrew upgrade hugoupgrade to latest version
- If a page bundle is Chinese only
- no need to have index.md placeholder
- use
test.jpgin index.zh-cn.md to refer to thetest.zh-cn.jpgfileandfigureshortcode both work
- Create a new single page
- doc style themes
- Learn https://learn.netlify.app/en/
- good for linear tutorial
- Doks https://doks.netlify.app/
- contains both docs and blog session and look good
- search only shows page. no highlight within context.
- Next blog theme?! Sell myself as a product?
- Book https://hugo-book-demo.netlify.app/
- used to use this one. does not look that good
- Geekdocs https://geekdocs.de
- similar to book but looks slightly nicer
- Docsy https://example.docsy.dev/
- comes from google. does not look that good.
- other options
- GitBook
- limited theme (no dark mode)
- folder is a mess
- but it’s simple to host
- mkdoc-material https://github.com/squidfunk/mkdocs-material
- uses python, so build time will be long.
- config looks complicated.
- GitBook
- Learn https://learn.netlify.app/en/