Hello and welcome!
This manual will show you how to run Hugo and Hugo server directly from your command line!
With the help of Hugo, you can create, view, enhance inputs for Knowledge Base and contribute to PIRL community.
This guide will explain how to download, setup and run Hugo and Hugo server:
For granting the success of this operation, you will need these requirements:
1) Mac iOS
If you are a Mac user, install Hugo with one strong, simple command.
brew install Hugo
Follow installation guide here
2) Windows OS
- If you use a Windows as I do, simply download the latest version of Hugo for Windows if you haven’t done it yet.
- Download most recent PIRL docs file depository if you haven’t done it yet. Unzip/extract both of these two folders.
- Then go into Hugo folder and copy everything you will find there.
- Jump to the PIRL docs folder and past all HUGO files there and rewrite files if needed.
- Then press Search button nearby the main Windows start button in the left down corner (standardly it is here :) )
- Write a CMD in the empty line and hit Enter.
- Now you can see exactly what do I need to write every time I want to run Hugo server and write down some KnowledgeBase (KB) article.
- First I need to locate my destination (in this case it is a Disk D and some further folders). Then I will make my move toward the Hugo folder.
Commands in CMD:
- D:>cd D:\PIRL\HUGO\pirl-docs-master\pirl-docs-master
- Hugo.exe server
- For shutting Hugo server down press: CTRL+C
3) Linux OS
I have created two possible ways for downloading, installation and running Hugo. Pick what is more OK for you.
a) Install by the package manager
b) Alternatively, install via a shell script and then use another script for comfortable repetitive Startup
tar -xf hugo_0.49_Linux-64bit.tar.gz
Repetitive Startup script
pkill -f hugo.sh
Checking in the Web browser
When your installation is done, start the web browser and type in:
- Welcome in the Matrix. Now you can edit or create new index files and help us create another studding knowledge based articles.
- For doing so, pick the text editor which suit your needs. I prefer Atom. Its really easy to use and its also GitLab user friendly.