Skip to content

fisodd/hugo-b-side

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hugo B-side

A theme for Hugo using reStructuredText markup to produce clean column-and-sidenotes article postings

See the live demo.

Features

  • Responsive 2-column page layout (scales from 300 to 1300 pixels wide)
  • Supports reStructuredText markup features

Including

With

  • The ability to place any of these elements in a sidebar that runs the length of the page.

All of these features and some more are demonstrated in the live demo.

Screenshot

Installation

Installation is much like any other Hugo theme.

Use of the reStructuredText features will require the installation of Docutils (and Pygments for code highlighting), but Hugo automatically recognizes ReST files and will call these packages if installed.

Getting started

Inside the folder of your Hugo site run:

$ cd themes
$ git clone https://github.com/fisodd/hugo-b-side.git

For more information read install and use themes or begin with Hugo's get started help page.

The config file

Inside the exampleSite folder of this theme, there is a file called config.toml. Use this configuration as an example, and modify to suit your needs.

Create your content as ReST files

Create a piece of content with ".rst" as the suffix.

example:

$ hugo new content/post/first-post.rst

Note: Hugo recognizes files ending with a ".rst" suffix as reStructuredText and will call out to the docutils python package to process these files.

See the results

In order to see your site in action, run Hugo's built-in local server.

$ hugo server

Now enter localhost:1313 in the address bar of your browser.

License

This theme is released under the MIT License.

The specifics can be found within the License

Recognition

The layout and style of this theme was inspired by Tufte CSS and the other projects following the ideas of Edward Tufte.

The author learned most of what he has learned about Hugo themes by studying the excellent example of the Ananke theme. I am very grateful for the clean implementation and the helpful comments.

Also, many, many thanks to all the folks who make Hugo rock.

About

A Hugo theme using reStructuredText markup to produce clean column-and-sidenotes article postings

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published