diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 146 |
1 files changed, 7 insertions, 139 deletions
@@ -1,13 +1,10 @@ hugo-bootstrap ============== -A theme with bootstrap, bootswatch(optional), font-awesome, highlightjs +A theme with bootstrap 4, font-awesome, highlightjs -*NOTE: This theme is copied from Hyde-Y. Not everything is ported to bootstrap. +*NOTE: This theme is copied inspired [Icarus] https://github.com/digitalcraftsman/hugo-icarus-theme Feel free to make changes and open pull requests.* - -<small>Forked from [Hyde-Y](https://github.com/enten/hyde-y)</small> - You can find a live site using this theme [here](http://mmrath.com/). ## Screenshot @@ -34,10 +31,9 @@ This theme expects a relatively standard Hugo blog/personal site layout: ├── post | ├── post1.md | └── post2.md - ├── code - | ├── project1.md - | ├── project2.md - ├── license.md // this is used in the sidebar footer link + ├── page + | ├── about-me.md + | ├── license.md └── other_page.md ``` @@ -45,140 +41,12 @@ Just run `hugo --theme=hugo-bootstrap` to generate your site! ## Configuration +Please see the config file of the example site in this repo for details of confguration. + ### Hugo An example of what your site's `config.toml` could look like. All theme-specific parameters are under `[params]` and standard Hugo parameters are used where possible. -``` toml -# hostname (and path) to the root eg. http://spf13.com/ -baseurl = "http://www.example.com" - -# Site title -title = "sitename" - -# Copyright -copyright = "(c) 2015 yourname." - -# Language -languageCode = "en-EN" - -# Metadata format -# "yaml", "toml", "json" -metaDataFormat = "yaml" - -# Theme to use (located in /themes/THEMENAME/) -theme = "hugo-bootstrap" - -# Pagination -paginate = 10 -paginatePath = "page" - -# Enable Disqus integration -disqusShortname = "your_disqus_shortname" - -[permalinks] - post = "/:year/:month/:day/:slug/" - code = "/:slug/" - -[taxonomies] - tag = "tags" - topic = "topics" - -[author] - name = "yourname" - email = "yourname@example.com" - -# -# All parameters below here are optional and can be mixed and matched. -# -[params] - # You can use markdown here. - brand = "foobar" - topline = "few words about your site" - footline = "code with <i class='fa fa-heart'></i>" - - # Show a sidebar menu - showRightSidebar = true - - # Text for the top menu link, which goes the root URL for the site. - # Default (if omitted) is "Home". - home = "home" - - # Select a syntax highight. - # Check the static/css/highlight directory for options. - highlight = "default" - - # Google Analytics. - googleAnalytics = "Your Google Analytics tracking code" - - # Sidebar social links. - github = "enten/hugo-boilerplate" # Your Github profile ID - bitbucket = "" # Your Bitbucket profile ID - linkedin = "" # Your LinkedIn profile ID (from public URL) - googleplus = "" # Your Google+ profile ID - facebook = "" # Your Facebook profile ID - twitter = "" # Your Twitter profile ID - youtube = "" # Your Youtube channel ID - flattr = "" # populate with your flattr uid - -[blackfriday] - angledQuotes = true - fractions = false - hrefTargetBlank = false - latexDashes = true - plainIdAnchors = true - extensions = [] - extensionmask = [] - -``` - -### Menu - -Create `data/Menu.toml` to configure the sidebar navigation links. Example below. - -```toml -[about] - Name = "About" - IconClass = "fa-info-circle" - URL = "/about" - -[posts] - Name = "Posts" - Title = "Show list of posts" - URL = "/post" - -[tags] - Name = "Tags" - Title = "Show list of tags" - URL = "/tags" -``` - -### Foot menu - -Create `data/FootMenu.toml` to configure the footer navigation links. Example below. - -```toml -[license] - Name = "license" - URL = "/license" -``` - -## Tips - -* If you've added `theme = "hugo-bootstrap"` to your `config.toml`, you don't need to keep using the `--theme=hugo-bootstrap` flag! -* Although all of the syntax highlight CSS files under the theme's `static/css/highlight` are bundled with the site, only the one you choose will be included in the page and delivered to the browser. -* Change the favicon by providing your own as `static/favicon.png` (and `static/touch-icon-144-precomposed.png` for Apple devices) in your site directory. -* Hugo makes it easy to override theme layout and behaviour, read about it [here](http://gohugo.io/themes/customizing). -* Pagination is set to 10 items by default, change it by updating `paginate = 10` in your `config.toml`. - -## Changes and enhancements from the original theme - -* Modified to work with bootstrap and bootswatch -* ...many other small layout tweaks! - -## Attribution - -Obviously largely a port of the awesome [Hyde-Y](https://github.com/enten/hyde-y) theme. ## Questions, ideas, bugs, pull requests? |