findy-network.github.io

Findy Agency technical documentation and blog.

Setup local environment

1. Install hugo

   • install latest version: hugo version > 0.78
   • You must install extended Sass/SCSS version
   • On Linux, especially on Ubuntu, which have snap use the following:

   snap install hugo --channel=extended

   • On ARM (Sample, Linux Ubuntu), you can easily build it by your own:

   wget https://github.com/gohugoio/hugo/archive/refs/tags/v0.93.0.tar.gz
   tar -zxvf v0.93.0.tar.gz 
   cd hugo-0.93.0
   go build --tags extended
   sudo mv hugo /usr/local/bin/hugo

2. Clone repository:

   git clone git@github.com:findy-network/findy-network.github.io.git

   To get, e.g. dev branch from the server:

   git fetch origin dev:dev

3. Get PR branch to local examination:

   To get PR branch, e.g. add-getting-started-blog branch from the server:

   git fetch origin add-getting-started-blog:add-getting-started-blog

4. Install dependencies

   cd findy-network.github.io
   npm install

5. Run hugo

   By using a make rule run that will start hugo to be visible for the whole LAN or for ngrok.

   make run

   Naturally you can start it with hugo

   hugo server

   Or if you need to connect from some other host in the same network.

   hugo server --bind=0.0.0.0 --baseURL=http://0.0.0.0:1313

6. Open browser at http://localhost:1313 or if from other host use its address instead of localhost.

7. Problem Solving:

   • use extended version

   • use latest version of hugo

   • when writing a blog post's hugo header be aware that the date: field tell hugo when to publish. If you are currently constructing the post and want to see the rendering result use current or previous date.

   • read error messages carefully, any of the blog posts can cause whole subtree unable to be rendered.

   • If you face following error:

     Error: from config: failed to resolve output format "print" from site config

     Remove Hugo cache (sudo rm -rf $TMPDIR/hugo_cache) and try again

Releasing

Releases to GitHub pages https://findy-network.github.io are done via GitHub actions on merge to master.