Contains the code for the Hugo-based Ligato.io website. Upon changes detected in the github repo, it will be deployed using Netlify to replace the existing Ligato.io site.
Follow the instruction located here.
Don't worry about the theme in the quickstart guide. It is used just to get you going.
This site is using a modified Hugo-Fresh theme
Make sure you have the correct version of Hugo.
USER:ligato.io $ hugo version
Hugo Static Site Generator v0.54.0/extended darwin/amd64 BuildDate: unknown
The hugo-fresh theme is treated as a submodule
. This is required by Netlify
for automatic deployment.
Be sure to use THIS COMMAND
:
git clone --recurse-submodules git@github.com:ligato/ligato.io.git
cd ligato.io
hugo server -D
Go to localhost:1313 on your favorite browser and check it out.
This uses live reload so any changes will be instantaneous.
-
all content is written in markdown. For images, use markdown links or hugo shortcodes for images to work.
-
all content is contained in the content/ folder. You can see how sub-folders under content/ relate to specific content and corresponding templates in the layouts/ on the site.
-
all the content here is high-level. Detailed technical documentation is automatically retrieved from the Ligato docs repo and hosted on a readthedocs.org site which in turn is reachable by the
documentation
menu option at the top and various topic-specific pointers throughout the site. -
Check the
front matter
of new content/ md files. Sidebar, templates, title, etc. may change depending on the location in website. -
config.yaml
is the main config file.