Edit your site on your PC

We highly recommend the one-minute Github/Gitlab install using your web browser before considering following the steps on this page to download and edit your site on your computer.

Alternatively, we can skip the Github install for now, edit your site directly on your computer, and deploy later to your preferred provider.

For beginners, we recommend using the cloud editing tools rather than setting up an editing environment on your computer.

Prerequisites

Before downloading your site, lets first install Hugo Extended and its prerequisites.

Choose your operating system below to get started.

Windows

Open the Windows Powershell 5 app, installing it if necessary.

Install Scope, the package manager for Windows, by pasting the following commands into Powershell and pressing the Enter ↵ key:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
iwr -useb get.scoop.sh | iex

Press Y and enter if asked Do you want to change the execution policy?.

Install Hugo and its dependencies:

scoop install git go hugo-extended

Mac

Open the Terminal app.

Install Homebrew, the Mac package manager, by pasting the following command and pressing the Enter ↵ key:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"

Apply any Homebrew updates:

brew update && brew upgrade

Install Hugo and its dependencies:

brew install git golang hugo

Open the hidden ~/.zshrc (or ~/.bashrc) file in a text editor, add the following line, and restart your Terminal app so that Hugo can find the location of its Go dependency.

export PATH=$PATH:/usr/local/go/bin

Linux

For Ubuntu based distributions:

  • Download the Hugo Extended installer for Debian (hugo_extended_<VERSION>_Linux-64bit.deb) and double-click the downloaded file to install with Ubuntu Software Center.

For other Linux distributions:

Install Hugo’s Go dependency using Snap:

sudo snap install --classic go

Troubleshooting

For issues installing or using Hugo Extended and its dependencies, ask the Hugo community.

Download a Template

If you already created your site with Github:

  • locate your Github repository, and either download the ZIP or use Git clone to download it

Otherwise, create a new site by downloading a Starter Template either directly, or using Git:

If you downloaded a template, extract the ZIP file’s contents to a folder.

Then open your Terminal (Mac/Linux) or Powershell (Windows) app and use the cd command to navigate to your website folder.

  • On Windows, for example: cd ~\Downloads\starter-academic-master\starter-academic-master\
  • On Mac or Linux, for example: cd ~/Downloads/starter-academic-master/starter-academic-master/

View your site by running the following command:

hugo server

Hugo then provides you with a link (e.g. http://localhost:1313/) to open in your web browser.

Install a Markdown Editor

Choose a Markdown editor. If you’re unsure, we recommend Typora.

Typora

Get Typora, a beautifully simple and user-friendly editor with support for visualizing technical content, such as math and diagrams.

Visual Studio Code

Get Visual Studio Code, a popular editor with an active online community for support.

JupyterLab

Get JupyterLab, a familiar editor for data analysts, data scientists, and researchers.

RStudio

A popular editor with statisticians.

  1. Open RStudio and install Blogdown:

     remotes::install_github('rstudio/blogdown')
    
  2. Open academic.Rproj from your site’s folder, downloading it if necessary

  3. Blogdown will automatically move your site’s config/_default/config.toml file to the site folder as Blogdown does not fully support Hugo’s config folder

  4. In the RStudio menu bar, choose Addins > Serve Site (clicking this button will call blogdown:::serve_site())

    • Paste the local URL which RStudio provides (e.g. http://127.0.0.1:4321) into your web browser to preview your new site
    • Avoid using the integrated RStudio web browser as it is very outdated and buggy

We recommend saving R content as Markdown with the .Rmarkdown file extension rather than as HTML with the .Rmd extension.

Unlock rewards

We’re full steam ahead on improving Wowchemy, and we need your help!

Edit your site

Follow the step by step guide to setup your new site.

For inspiration, refer to the Markdown content which powers the Academic Template.

Previous
Next