Time for Action
Create a folder for your source code. For example in
~/Documents/website (not in
~/public_html!) and there, type:
git clone https://github.com/sourcethemes/academic-kickstart.git professional cd professional git submodule update --init --recursive hugo serve
This will launch a local web server. In your favorite browser (firefox, chrome,
edge, …) go to
http://localhost:1313: you should get a website talking about the Academic theme, something like the image below:
Now you definitely want to customize our website! Prior to that, lets just have a few words about the folders composing your repository:
config/_default/: Starts here: open the configuration files there and changes the meta-data as you want
content/: This is where the content of your website is stored, in the form of markdown files
content/home: Homepage, every
index) is a widget that you can activate or not
content/post: Your Post messages (blog)
content/project: Your projects
content/publication: Your scientific papers
content/talk: Your talks
static/: Local files (image, …) that will be available online
Finally, never modify files located in
themes/academic folder! Otherwise, you will not be able to get updates. The
themes/academic/exampleSite folder is great to get up-to-date examples, though!
You should now go to the documentation of the Academic theme to get a nice and customed webpage.
Hugo : tips & tricks
config/_default/config.toml, there is a line for the
baseurl = "/"
There you must provide the base url of your website. For example, if your website is hosted at
https://my-lab/users/~me/ then you should copy paste that URL into
baseurl = "https://my-lab/users/~me/"
This helps hugo to search for the file in the right place, especially the
.css file (design)!
Basically, the structure of your
content/ folder will be kept in your future website:
You can hence add custom folders and files in your
content folder (you are not restricted by the theme!).
A good idea though, is to keep the
page bundle system: one folder per “page”. For example, if you want to add a page, say
website.com/legal, declaring the Legal Notice of your website, you can create a folder and file at