Skip to content

Latest commit

 

History

History
76 lines (48 loc) · 3.48 KB

README.md

File metadata and controls

76 lines (48 loc) · 3.48 KB

Minimalist Menu

Minimalist Menu is a fork of Minimalist Hugo theme made by Digitalcraftsman.

Minimalist is it self based on the Minimalistic Ghost theme made by Raphael Riegger.

Noteworthy features of this Hugo theme are a menu adapted to mobile and desktop devices, the integration of a comment-system powered by Disqus, easy localization (l10n), support for RSS feeds, syntax highlighting for source code and sharing options in the blog posts.

Desktop screenshot

Mobile screenshot

Preview & Installation

Preview

The theme ships with an exampleSite folder that acts as a demo setup. cd into this folder an start the Hugo:

git clone https://github.com/ycornamusaz/hugo-minimalist-theme.git
cd hugo-minimalist-theme/exampleSite
hugo server

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

Installation

If you want to use this theme for an actual website create a new Hugo project and clone the theme:

cd themes
git clone https://github.com/ycornamusaz/hugo-minimalist-theme.git

Note: make sure to remove themesDir = "../.." from the top of your config file if you copied it from exampleSite/config.toml. Otherwise, Hugo will be unable to find the theme.

For more information read the official setup guide of Hugo.

The Config File

Take a look inside the exampleSite folder of this theme. You'll find a file called config.toml.

To use it, copy the config.toml to the root folder of your Hugo site. Play around with the settings to tweak your site as you like.

Localization (l10n)

Localization allows you to easily translate all strings in our website. Within exampleSite/data you'll find a file called l10n.toml. If you're not blogging in English replace all strings with their equivalents of your preferred language.

Contributing

Did you find a bug or have an idea for a new feature? Feel free to use the issue tracker to let me know. Or create a pull request. Please create a seperate branch for your pull request.

License

This theme is released under the Apache License 2.0. For more information read the License.

Acknowledgements

Big thanks to