Code Monkey home page Code Monkey logo

hugo-minimalist-theme's Introduction

Minimalist

Minimalist is a responsive theme with a focus on blogging based on the Minimalistic Ghost theme made by Raphael Riegger.

Noteworthy features of this Hugo theme are 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.

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/digitalcraftsman/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/digitalcraftsman/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

Thanks to

hugo-minimalist-theme's People

Contributors

digitalcraftsman avatar cliffano avatar geoffholden avatar ham1 avatar svenito avatar

Watchers

James Cloos avatar Simon Hartcher avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.