Tuesday, July 7, 2020

Generating a Site for Documentation

Have you been looking for an easy way to generate a site for documentation? Where you don't have to do all the web foundation work to make it look and work great. I found Hugo to be an awesome tool to do just that. 

What is Hugo?
"Hugo is one of the most popular open-source static site generators. With its amazing speed and flexibility, Hugo makes building websites fun again."

  • Really fast build times
  • Multi-language support, multilingual and i18n
  • Markdown support with shortcodes
  • Flexible content management system (CMS)
  • Hundreds of themes to choose from
  • More...
Generate and Run a Docsy Site

1. Install
2. Download
Download the Docsy example. Git is used to download the example.
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
3. Run the Web Server
cd docsy-example
hugo server 
4. Load the Docsy Site

The link will be in the output and will look like http://localhost:1313. 

Find out more about what Hugo can do for your site.

No comments:

Trying out the Dart Analysis Server

I wanted to see how the Dart Analysis Server was put together and worked. I started looking to see how I could wire it up and try out the co...