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
- Images and figures
- Sidenotes and citations
- Pull-quotes and epigraphs
- Sidebars
- Admonitions and topics, notably including topics containing the table of contents
- Support for inline math and code directives
- Tables, including all forms of reStructuredText alternative table markup: list-tables, field lists, even bibliographic fields
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.
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.
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.
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 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.
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.
This theme is released under the MIT License.
The specifics can be found within the License
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.