Skip to content

goopyflux/manifest

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

What?

Manifest is a theme for the static site generator Hugo.

Manifest

man.i.fest (adjective)

clear or obvious to the eye or mind

Demo

View demo here

Design

  • High impact home/landing page, using only text
  • Emphasis on text legibility and readability
  • Site navigation aimed to reduce clicks
  • Clean, lean, minimal and functional
  • Near-black, near-white and gray color scheme
  • Pro-web accessibility
  • Responsive

Features

  • Stays out of the way and puts the emphasis on content and readability
  • Uses Tachyons CSS for styling
  • Designed with web accessibility in mind
  • Aims to be generic enough for various use cases
  • Dedicated landing page
  • List and sigle views
  • Title, summary, wordcount and reading time in list view
  • Taxonomy using tags and categories
  • Multiple menus - one on home page; one in list and single views and one in the footer
  • Uses Highlight.js for syntax highlighting, which is optional and is controlled by the UseHighlightJS parameter in config.toml
  • Social icons integration

Why?

Simple answer is because I am picky. There are plenty of great themes available. What started as a simple clone and use with a few candidate themes, quickly turned into tweaking, picking and choosing features from various themes, with no end. It was at this point I also realized the scalability issue with traditional CSS.

Enter Tachyons - a functional CSS for humans. Its beautiful, responsive, readable, performant, modular, lightweight, simply awesome! I just had to use it.

Usage

  1. Install Hugo and create a new website:
hugo new site my_website
cd my_website
  1. Install Manifest theme with git:
 git clone https://github.com/goopyflux/manifest.git themes/manifest

Or alternatively, download Manifest and extract it into a themes/manifest folder within your Hugo website.

  1. If you are creating a new website, copy the contents of the exampleSite folder to your website root folder, overwriting existing files if necessary. The exampleSite folder contains an example config file and content to help you get started.
cp -av themes/manifest/exampleSite/* .
  1. Start the Hugo server from your website root folder:
hugo server --watch

Now you can go to localhost:1313 and your new Manifest themed website should appear.

  1. Customize your website (see next section), build it by running hugo, and deploy it by copying the public/ directory (by FTP, Rsync, git push, etc.) to your production web server.

About

I had a vision for what the website should look like. It was made into a reality due to the kindness of others. Thanks in particular to:

This is my attempt to pay it forward.

Getting Started

More details coming soon...

Upgrading

Feel free to star the project on Github and monitor the commits for updates.

Before upgrading the theme, it is recommended to make a backup of your entire website directory, or at least your themes/manifest directory. You can also read about the most recent milestones (but this doesn't necessarily reflect the latest master release).

Before upgrading for the first time, the remote origin repository should be renamed to upstream:

    $ cd themes/manifest
    $ git remote rename origin upstream

To list available updates:

    $ cd themes/manifest
    $ git fetch upstream
    $ git log --pretty=oneline --abbrev-commit --decorate HEAD..upstream/master

Upgrade by running:

    $ cd themes/manifest
    $ git pull upstream

If you have modified files in themes/manifest, git will attempt to auto-merge changes. If conflicts are reported, you will need to manually edit the files with conflicts and add them back (git add <filename>).

If there are any issues after upgrading, you may wish to compare your site with the latest example site to check if any settings changed.

Contributing

Please use the issue tracker to let me know about any bugs or feature requests, or alternatively make a pull request.

License

Released under the MIT license.

About

A clean, responsive theme for Hugo using Tachyons CSS.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published