etl/install-hugo.md at 8f8da9a48e69f9339c34524fd7dfa4fdabc1a783

coffee/etl

mirror of https://github.com/ETLCPP/etl.git synced 2026-06-26 20:38:45 +08:00

John Wellbelove 4a88884b39

Issue/add hugo support for documentation (#1449 )

* Add ranges

* Initial Hugo setup

* Work in progress

* Added selection for local or remote site

* Updated to 'light' theme

* Changed to using Hextra Hugo theme

* Changed to using Hextra Hugo theme

* Changed to Hextra Hugo theme

* Change to Hextra Hugo theme

* Updated Hugo setup.

* Updated Hugo setup.

# Conflicts:
#	docs/releases/_index.md

* Work in progress

* Added new fonts

Added new documentation

* Latest documentation updates

* Latest documentation updates

# Conflicts:
#	docs/containers/array.md
#	docs/containers/array_view.md
#	docs/containers/array_wrapper.md
#	docs/containers/bip_buffer_spsc_atomic.md
#	docs/containers/bitset.md
#	docs/containers/indirect_vector.md
#	docs/containers/vector.md
#	docs/getting-started/compilers.md

* Added bloom_filter markdown doc

* Added more documentation

Updated CSS for light and dark modes

* Fixed some menus

Added mode documentation files

* Updated CSS rules

Added badges to home page
Added uniqur_ptr + pool tutorial

* Fixed formatting on the home page markdown

Modified light amd dark code formatting

* Updated unique_ptr-with-pool

* Added container and shared message tutorials

* Updates to documentation

* Added const_multimap

* Updated source-formatting.md

* Added initial raw text files form Web site editor

* Innore coverage build directory

* Exported raw text documentation files from the web site editor

* Hugo updates

* Added Hugo intalation and markdown descriptions

* More addition to the documentation

* Added closure.md and updates to delegate.md

* Added format.md

* Added documentation for etl::delegate_observable, etl::function, Base64 codec

* Added io_port documentation

* Added basic_format_spec

* Added documentation for string_stream and string utilities.

* Added more documentation

Updated the documentation CSS

* Added documentation for clocks, day, duration

* Added more documentation for chrono classes

Updated callouts

* More chrono documentation

* Completed chrono documentation

* Maths functions documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Completed maths documentation

* Added multiple documentation files

* Added iterator.md

* Added debug_count.md and versions.md

* Added debug_count.md and versions.md

* Added more documentation

* More documentation

* Added some design pattern documentation

Modified some of the layout files
Modified the About documentation

* Converted more documentation pages

Modified the site CSS

* Added more documentation

Moced some documentation files to new directories

* Added more documentation

Tweaks to CSS

* Added callback_timer_deferred_locked documentation

* Added callback_timer_locked documentation

* More documentation updates

* More documentation updates

* More documentation updates

* New documentation files.

Harmonised file name format

* New documentation files.

* Multiple document updates

* Multiple document updates

* Final conversion of web pages

* Updates before PR

* Updates before PR

* Updates before PR

# Conflicts:
#	docs/blog/_index.md

* Final pre PR updates

* Updates to message framework documentation

* Renamed directory

* Fix spelling

* Added author and date to blog files

Moved documentation files merged from development

* Fixed 'Description' typo

* Fix typos

# Conflicts:
#	docs/IO/io_port.md
#	docs/containers/sets/const-multiset.md
#	docs/containers/sets/const-set.md
#	docs/maths/correlation.md
#	docs/maths/gamma.md

* Renamed two files to lower case

* Minor renaming

* Added author and date

* Updated callout on bresenham_line.md

Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset.
Updated the Python 'update_release.py' to copy 'version.txt'

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

* Replace space in filename with hyphen.

Added more information to hugo-commands.md

# Conflicts:
#	docs/getting-started/view-the-docs-locally/hugo-commands.md

* Added a link to pseudo_moving_average.md

* Updated title pages for groups

* Fixed missing 404 for non-existent pages

* Fixed coordinate variable names in the 'Calculating the intersection' example

---------

Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>

2026-06-06 13:12:44 +01:00

2.6 KiB

Raw Blame History

title	weight
Install Hugo	72

You need to install Hugo if you want to replicate the ETL online documentation.

You need to install the extended version of Hugo on each platform:

The extended version includes support for Sass/SCSS compilation and WebP image processing, which is required by many Hugo themes.

Install Go

Hugo requires Go to support Hugo Modules.

Visit here to install the version applicable to your OS.

Check that it is installed correctly with the command

go version

Windows

Option 1: Winget (recommended)

winget install Hugo.Hugo.Extended

Option 2: Chocolatey

choco install hugo-extended

Option 3: Scoop

scoop install hugo-extended

Option 4: Manual

Download the hugo_extended_x.x.x_windows-amd64.zip from the Hugo releases page
Extract the zip and place hugo.exe in a folder (e.g. C:\Hugo\bin)
Add that folder to your system PATH

Linux

Option 1: Snap

sudo snap install hugo --channel=extended/stable --classic

Option 2: Package manager (Debian/Ubuntu)

sudo apt install hugo

⚠️ Apt may serve an older version. Prefer snap or manual install for the latest extended build.

Option 3: Manual (always latest)

# Replace x.x.x with the latest version number
wget https://github.com/gohugoio/hugo/releases/download/vx.x.x/hugo_extended_x.x.x_linux-amd64.tar.gz
tar -xzf hugo_extended_x.x.x_linux-amd64.tar.gz
sudo mv hugo /usr/local/bin/

macOS

Option 1: Homebrew (recommended)

brew install hugo

Homebrew installs the extended version by default.

Option 2: MacPorts

sudo port install hugo

Option 3: Manual

Download hugo_extended_x.x.x_darwin-universal.tar.gz from the Hugo releases page
Extract and move the binary:

tar -xzf hugo_extended_*.tar.gz
sudo mv hugo /usr/local/bin/

Verify the installation

On all platforms, confirm it's the extended version:

hugo version

You should see +extended in the output, e.g.:

hugo v0.147.0+extended linux/amd64 BuildDate=...

2.6 KiB Raw Blame History