diff --git a/themes/binario/.editorconfig b/themes/binario/.editorconfig deleted file mode 100644 index cc699fa..0000000 --- a/themes/binario/.editorconfig +++ /dev/null @@ -1,19 +0,0 @@ -# editorconfig.org -root = true - -[*] -charset = utf-8 -indent_style = tab -end_of_line = lf -trim_trailing_whitespace = true -insert_final_newline = true - -[*.md] -trim_trailing_whitespace = false - -[*.{json,yaml,yml,toml,md,babelrc,eslintrc,stylelintrc}] -indent_style = space -indent_size = 2 - -[layouts/**.{html,svg}] -insert_final_newline = false diff --git a/themes/binario/.stylelintrc b/themes/binario/.stylelintrc deleted file mode 100644 index 433e93f..0000000 --- a/themes/binario/.stylelintrc +++ /dev/null @@ -1,319 +0,0 @@ -{ - "plugins": [ - "stylelint-order" - ], - "rules": { - "at-rule-empty-line-before": [ - "always", - { - "except": [ - "blockless-after-same-name-blockless", - "first-nested" - ], - "ignore": [ - "after-comment" - ] - } - ], - "at-rule-name-case": "lower", - "at-rule-name-space-after": "always-single-line", - "at-rule-semicolon-newline-after": "always", - "block-closing-brace-newline-after": "always", - "block-closing-brace-empty-line-before": "never", - "block-no-empty": true, - "block-opening-brace-newline-after": "always-multi-line", - "color-hex-case": "lower", - "color-hex-length": "short", - "color-no-invalid-hex": true, - "comment-no-empty": true, - "declaration-bang-space-after": "never", - "declaration-bang-space-before": "always", - "declaration-block-no-duplicate-properties": [ - true, - { - "ignore": [ - "consecutive-duplicates-with-different-values" - ] - } - ], - "declaration-block-no-shorthand-property-overrides": true, - "declaration-block-semicolon-newline-after": "always-multi-line", - "declaration-block-semicolon-space-after": "always-single-line", - "declaration-block-semicolon-space-before": "never", - "declaration-block-single-line-max-declarations": 1, - "declaration-block-trailing-semicolon": "always", - "declaration-colon-newline-after": "always-multi-line", - "declaration-colon-space-after": "always-single-line", - "declaration-colon-space-before": "never", - "font-family-no-duplicate-names": true, - "function-calc-no-unspaced-operator": true, - "function-comma-newline-after": "always-multi-line", - "function-comma-space-after": "always-single-line", - "function-comma-space-before": "never", - "function-linear-gradient-no-nonstandard-direction": true, - "function-max-empty-lines": 0, - "function-name-case": "lower", - "function-parentheses-newline-inside": "always-multi-line", - "function-parentheses-space-inside": "never-single-line", - "function-whitespace-after": "always", - "indentation": "tab", - "keyframe-declaration-no-important": true, - "length-zero-no-unit": true, - "max-empty-lines": 1, - "media-feature-colon-space-after": "always", - "media-feature-colon-space-before": "never", - "media-feature-name-case": "lower", - "media-feature-name-no-unknown": true, - "media-feature-parentheses-space-inside": "never", - "media-feature-range-operator-space-after": "always", - "media-feature-range-operator-space-before": "always", - "media-query-list-comma-newline-after": "always-multi-line", - "media-query-list-comma-space-after": "always-single-line", - "media-query-list-comma-space-before": "never", - "no-empty-source": true, - "no-eol-whitespace": true, - "no-extra-semicolons": true, - "no-invalid-double-slash-comments": true, - "no-missing-end-of-source-newline": true, - "number-no-trailing-zeros": true, - "property-case": "lower", - "property-no-unknown": true, - "selector-attribute-brackets-space-inside": "never", - "selector-attribute-operator-space-after": "never", - "selector-attribute-operator-space-before": "never", - "selector-combinator-space-after": "always", - "selector-combinator-space-before": "always", - "selector-descendant-combinator-no-non-space": true, - "selector-list-comma-newline-after": "always", - "selector-list-comma-space-before": "never", - "selector-pseudo-class-case": "lower", - "selector-pseudo-class-no-unknown": true, - "selector-pseudo-class-parentheses-space-inside": "never", - "selector-pseudo-element-case": "lower", - "selector-pseudo-element-colon-notation": "double", - "selector-pseudo-element-no-unknown": true, - "selector-type-case": "lower", - "selector-type-no-unknown": true, - "shorthand-property-no-redundant-values": true, - "string-no-newline": true, - "unit-case": "lower", - "unit-no-unknown": true, - "value-list-comma-newline-after": "always-multi-line", - "value-list-comma-space-after": "always-single-line", - "value-list-comma-space-before": "never", - "value-list-max-empty-lines": 0, - "order/properties-order": [ - "position", - "top", - "right", - "bottom", - "left", - "z-index", - "box-sizing", - "display", - "flex", - "flex-align", - "flex-basis", - "flex-direction", - "flex-wrap", - "flex-flow", - "flex-shrink", - "flex-grow", - "flex-wrap", - "align-content", - "align-items", - "align-self", - "justify-content", - "order", - "float", - "width", - "min-width", - "max-width", - "height", - "min-height", - "max-height", - "padding", - "padding-top", - "padding-right", - "padding-bottom", - "padding-left", - "margin", - "margin-top", - "margin-right", - "margin-bottom", - "margin-left", - "overflow", - "overflow-x", - "overflow-y", - "-webkit-overflow-scrolling", - "-ms-overflow-x", - "-ms-overflow-y", - "-ms-overflow-style", - "columns", - "column-count", - "column-fill", - "column-gap", - "column-rule", - "column-rule-width", - "column-rule-style", - "column-rule-color", - "column-span", - "column-width", - "orphans", - "widows", - "clip", - "clear", - "font", - "font-family", - "font-size", - "font-style", - "font-weight", - "font-variant", - "font-size-adjust", - "font-stretch", - "font-effect", - "font-emphasize", - "font-emphasize-position", - "font-emphasize-style", - "font-smooth", - "src", - "hyphens", - "line-height", - "color", - "text-align", - "text-align-last", - "text-emphasis", - "text-emphasis-color", - "text-emphasis-style", - "text-emphasis-position", - "text-decoration", - "text-indent", - "text-justify", - "text-outline", - "-ms-text-overflow", - "text-overflow", - "text-overflow-ellipsis", - "text-overflow-mode", - "text-shadow", - "text-transform", - "text-wrap", - "-webkit-text-size-adjust", - "-ms-text-size-adjust", - "letter-spacing", - "-ms-word-break", - "word-break", - "word-spacing", - "-ms-word-wrap", - "word-wrap", - "overflow-wrap", - "tab-size", - "white-space", - "vertical-align", - "direction", - "unicode-bidi", - "list-style", - "list-style-position", - "list-style-type", - "list-style-image", - "pointer-events", - "-ms-touch-action", - "touch-action", - "cursor", - "visibility", - "zoom", - "table-layout", - "empty-cells", - "caption-side", - "border-spacing", - "border-collapse", - "content", - "quotes", - "counter-reset", - "counter-increment", - "resize", - "user-select", - "nav-index", - "nav-up", - "nav-right", - "nav-down", - "nav-left", - "background", - "background-color", - "background-image", - "filter", - "background-repeat", - "background-attachment", - "background-position", - "background-position-x", - "background-position-y", - "background-clip", - "background-origin", - "background-size", - "border", - "border-color", - "border-style", - "border-width", - "border-top", - "border-top-color", - "border-top-style", - "border-top-width", - "border-right", - "border-right-color", - "border-right-style", - "border-right-width", - "border-bottom", - "border-bottom-color", - "border-bottom-style", - "border-bottom-width", - "border-left", - "border-left-color", - "border-left-style", - "border-left-width", - "border-radius", - "border-top-left-radius", - "border-top-right-radius", - "border-bottom-right-radius", - "border-bottom-left-radius", - "border-image", - "border-image-source", - "border-image-slice", - "border-image-width", - "border-image-outset", - "border-image-repeat", - "outline", - "outline-width", - "outline-style", - "outline-color", - "outline-offset", - "box-shadow", - "opacity", - "-ms-interpolation-mode", - "page-break-after", - "page-break-before", - "page-break-inside", - "transition", - "transition-delay", - "transition-timing-function", - "transition-duration", - "transition-property", - "transform", - "transform-origin", - "perspective", - "appearance", - "animation", - "animation-name", - "animation-duration", - "animation-play-state", - "animation-timing-function", - "animation-delay", - "animation-iteration-count", - "animation-direction", - "animation-fill-mode", - "quotes", - "will-change", - "fill", - "fill-rule", - "stroke" - ] - } -} diff --git a/themes/binario/CONTRIBUTING.md b/themes/binario/CONTRIBUTING.md deleted file mode 100644 index fa6cb89..0000000 --- a/themes/binario/CONTRIBUTING.md +++ /dev/null @@ -1,132 +0,0 @@ -# Contributing to Binario - -**Binario** welcomes contributions and corrections. Before contributing, please make sure you have read the guidelines -below. If you're a newcomer to open source and you haven't contributed to other projects or used -[Git](https://git-scm.com/) before, you should make yourself familiar before proceeding. - -## Issues - -The [issue tracker](https://github.com/vimux/binario/issues) is the preferred channel for bug reports and features -requests, but please respect the following restrictions: - -### General requirements - -* Issue must be written in English. -* Please **do not** combine a few problems or feature requests in one issue. Create separate issues if needed. -* Please **do not** create an issue that contains only title. Write a clear title and useful description. -* Please **do not** use the issue tracker for personal support requests. -* Please **do not** post comments consisting solely of "+1" or emoji. The project maintainer reserve the right to delete -such comments. Use -[GitHub's reactions feature](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments) instead. -* Search first before filing a new issue. Please check existing open or recently closed issues to make sure somebody -else hasn't already reported the issue. - -### Reporting bugs - -When creating a new bug issue make sure to include the following information: - -* Your environment e.g. OS version, Hugo version, theme is up to date? Anything unusual about your environment or -deployment. -* Specify the exact steps to reproduce the bug in as many details as possible with code examples. Include links to files -or demo projects, or copy/pasteable snippets, which you use in those examples. -* Any message or error you get from Hugo, if you do. -* A screenshot of any visual bug. - -Please, take in consideration the next template to report your bug: - -> **Hugo version**\ -> _Run `hugo version` and paste output here._ -> -> **Theme is up to date?**\ -> _No | Yes_ -> -> **Expected behavior**\ -> _A short and expressive description of what behavior you're expecting._ -> -> **Current behavior**\ -> _A short sentence explaining what's actually happening, possibly containing screenshots._ -> -> **Steps to reproduce / Code to reproduce**\ -> _A step by step description of how to trigger this bug. / Provide link to a demo project which reproduces this bug._ -> -> **Additional info**\ -> _Anything unusual about your environment or deployment process? Anything else do we need to know? Optional._ - -**Note:** If you find a **Closed** issue that seems like it is the same bug that you're experiencing, open a new issue -and include a link to the original issue in the body of your new one. - -### Proposing features - -* Explain the proposed feature, what it should do, why it is useful, and alternatives considered if possible. Please -note that the project maintainer may close this issue or ask you to create a Pull Request if this is not something that -the project maintainer sees as a sufficiently high priority. - -Following these guidelines helps maintainer and the community understand your suggestion and find related suggestions. - -## Pull Requests (PR) - -**Please ask first** before embarking on any significant pull request (e.g. implementing features or refactoring code), -otherwise, you risk spending a lot of time working on something that the project maintainer might not want to merge into -the project. - -Please respect our Pull Request Acceptance Criteria. For larger changes, you will likely receive multiple rounds of -comments and it may take some time to complete. - -### Pull Request Acceptance Criteria - -* Keep the change in a single PR as small as possible -* 1 PR = 1 FIX or FEATURE (do not combine things, send separate PR if needed) - * PR with irrelevant changes won't be merged. If you do want to fix formatting or style, do that in a separate PR -* Use a clear and descriptive branch name (e.g. **NOT** "patch-1" or "update") -* Don't create a Pull Request from master branch -* Provide a reasonable PR title and description - * PR must be written in English - * If the PR changes the UI it should include before-and-after screenshots or a link to a video -* Keep PR up to date with upstream/master -* Pay attention to any automated CI failures reported in the Pull Request -* PR solves a common use case that several users will need in their real-life projects, not only your specific problems -* Before you start something new or refactor something old, make sure you've read through the codebase and understand -each part's purpose so that you don't break something -* Always try to avoid breaking changes. But if they are needed, then mark each breaking commit with a -"BREAKING CHANGE:" prefix in the commit title and a detailed explanation in the commit description of what happened and -what the user needs to do -* Deprecated params must be maintained for a 6-month transition period -* If something mandates an unclear solution, leave a comment behind for the contributors that come after you -* If you've added or modify SVG, ensure that each SVG file: - * Be less than 2048 bytes - * Be minified to a single line with no formatting - * Not contain any JS or CSS section inside it - * Not contain any additional transformations (matrix, translate, scale) or negative viewBox position values - * Сompatible with [MIT License](LICENSE) -* Maintain clean commit history and use meaningful commit messages. Pull Requests with messy commit history (with -commit messages like "update", "another update", etc) are difficult to review and won't be merged, even if the changes -are good enough -* Be prepared to answer questions and make code changes. The project maintainer expect you to be reasonably responsive -to those feedback, otherwise the PR will be closed after 2-4 weeks of inactivity - -### Pull Request Contribution Prerequisites - -* You have Node & npm installed -* You have Hugo installed at v0.48.0+ -* You are familiar with Git - -### Pull Request Process - -1. Fork the repository -1. Clone down the repository to your local system -1. Run `npm i` in the repository root -1. Create a new *dedicated branch* with descriptive name from `master` -1. Make your change and commit to the new branch from the previous step - 1. Write a clear commit message - 1. If you've added code that need documentation, update the README.md -1. Make sure your code lints (`npm test`) -1. Push to your fork -1. Submit a Pull Request (PR) to the upstream - ---- - -**⚠️ IMPORTANT: No guarantees can be made that your pull request will be accepted.** - -## License - -By contributing to Binario, you agree that your contributions will be licensed under [MIT License](LICENSE). diff --git a/themes/binario/LICENSE b/themes/binario/LICENSE deleted file mode 100644 index 25bd836..0000000 --- a/themes/binario/LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2018 Vimux - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/themes/binario/README.md b/themes/binario/README.md deleted file mode 100644 index 11e33d8..0000000 --- a/themes/binario/README.md +++ /dev/null @@ -1,463 +0,0 @@ -# Binario - -**Binario** is a responsive card-based & code-light Hugo theme. - -**[Demo](https://binario.netlify.app/)** - - - -**Features:** - -* Responsive -* Card-based list layout -* Color themes -* Internal Hugo templates (Open Graph, Schema, Twitter Cards, Google Analytics, Disqus comments) -* Table of contents -* Related content -* MathJax - -## Table of Contents - -- [Installation](#installation) - - [Option A. Git clone](#option-a-git-clone) - - [Option B. Git submodule](#option-b-git-submodule) - - [Option C. Download ZIP and manual install](#option-c-download-zip-and-manual-install) -- [Configuration](#configuration) - - [Config.toml example](#configtoml-example) - - [Front Matter example](#front-matter-example) - - [Configuration options](#configuration-options) - - [Columns](#columns) - - [Custom CSS](#custom-css) - - [Custom JS](#custom-js) - - [Entry Meta](#entry-meta) - - [Related Content](#related-content) - - [Share Buttons](#share-buttons) - - [Featured Image](#featured-image) - - [Breadcrumb](#breadcrumb) - - [Footer Social Icons](#footer-social-icons) - - [Web App Manifest](#web-app-manifest) -- [Contributing](#contributing) -- [License](#license) - -## Installation - -*First of all, you will need to [install Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and -[create a new site](https://gohugo.io/getting-started/quick-start/#step-2-create-a-new-site). Also, you have git -installed on your machine and you are familiar with basic git usage. After that, you ready to install **Binario**.* - -There are three different ways you can install **Binario**. Choose one of the installation methods listed below and -follow the instructions. - -- **A**. [Git clone](#option-a-git-clone) -- **B**. [Git submodule](#option-b-git-submodule) -- **C**. [Download ZIP and manual install](#option-c-download-zip-and-manual-install) - -*For more information read the "[Install and Use Themes](https://gohugo.io/themes/installing-and-using-themes/)"*. - -### Option A. Git clone - -In your Hugo site directory, run: - -``` -git clone https://github.com/vimux/binario themes/binario -``` - -Next, edit your `config.toml` configuration file and add parameter: - -```toml -theme = "binario" -``` - -### Option B. Git submodule - -In your Hugo site directory, run: - -``` -git submodule add https://github.com/vimux/binario themes/binario -``` - -Next, edit your `config.toml` configuration file and add parameter: - -```toml -theme = "binario" -``` - -*You can [read the GitHub documentation for submodules](https://github.com/blog/2104-working-with-submodules) or those -found on [Git's website](https://git-scm.com/book/en/v2/Git-Tools-Submodules) for more information* - -### Option C. Download ZIP and manual install - -**[Download ZIP](https://github.com/vimux/binario/archive/master.zip)** and extract to the `themes/binario` within your -Hugo website. - -Next, edit your `config.toml` configuration file and add parameter: - -```toml -theme = "binario" -``` - -*** - -You can run your site in Hugo server mode: - -``` -hugo server -``` - -Now you can go to [localhost:1313](http://localhost:1313) webpage and the Binario theme should be visible. - -After you make sure that **Binario** works, you may start customizing the theme if it's needed. You can change -[number of columns](#columns), activate [footer social icons](#footer-social-icons), [share buttons](#share-buttons) and -[much more](#configuration-options). - -## Configuration - -Hugo uses the `config.toml`, `config.yaml`, or `config.json` (if found in the site root) as the default site config -file. Here is Binario configuration example in TOML with all available theme-specific config params: - -### Config.toml example - -```toml -baseurl = "/" -title = "Binario" -languageCode = "en-us" -paginate = "10" # Number of elements per page in pagination -theme = "binario" -disqusShortname = "" # DEPRECATED! Use .Services.Disqus.Shortname -googleAnalytics = "" # DEPRECATED! Use .Services.googleAnalytics.ID - -[services.disqus] - shortname = "" # Enable Disqus by entering your Disqus shortname -[services.googleAnalytics] - ID = "" # Enable Google Analytics by entering your tracking ID - -[Author] # Used in authorbox - name = "John Doe" - bio = "John Doe's true identity is unknown. Maybe he is a successful blogger or writer." - avatar = "img/avatar.png" - -[Params] - description = "Responsive card-based & code-light Hugo theme" # Site Description. Used in meta description - copyright = "Binario" # Copyright holder, otherwise will use .Site.Title - opengraph = true # Enable OpenGraph if true - schema = true # Enable Schema - twitter_cards = true # Enable Twitter Cards if true - columns = 2 # Set the number of cards columns. Possible values: 1, 2, 3 - mainSections = ["post"] # Set main page sections - dateFormat = "January 02, 2006" # Change the format of dates - colorTheme = "" # dark-green, dark-blue, dark-red, dark-violet - customCSS = ["css/custom.css"] # Include custom CSS files - customJS = ["js/custom.js"] # Include custom JS files - mainMenuAlignment = "right" # Align main menu (desktop version) to the right side - authorbox = true # Show authorbox at bottom of single pages if true - comments = true # Enable comments for all site pages - related = true # Enable Related content for single pages - relatedMax = 5 # Set the maximum number of elements that can be displayed in related block. Optional - mathjax = true # Enable MathJax for all site pages - mathjaxPath = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.6/MathJax.js" # Specify MathJax path. Optional - mathjaxConfig = "TeX-AMS-MML_HTMLorMML" # Specify MathJax config. Optional - hideNoPostsWarning = false # Don't show no posts empty state warning in main page, if true - -[Params.Entry] - meta = ["date", "categories", "tags"] # Enable meta fields in given order - toc = true # Enable Table of Contents - tocOpen = true # Open Table of Contents block. Optional - -[Params.Featured] - previewOnly = false # Show only preview featured image - -[Params.Breadcrumb] - enable = true # Enable breadcrumb block globally - homeText = "Binario" # Home node text - -[Params.Social] - email = "example@example.com" - facebook = "username" - twitter = "username" - telegram = "username" - instagram = "username" - pinterest = "username" - vk = "username" - linkedin = "username" - github = "username" - gitlab = "username" - stackoverflow = "numberid" - mastodon = "https://some.instance/@username" - medium = "username" - -[Params.Share] # Entry Share block - facebook = true - twitter = true - reddit = true - telegram = true - linkedin = true - vk = true - pocket = true - pinterest = true - -# Web App Manifest settings -# https://www.w3.org/TR/appmanifest/ -# https://developers.google.com/web/fundamentals/web-app-manifest/ -[Params.Manifest] - name = "Binario" - shortName = "Binario" - display = "browser" - startUrl = "/" - backgroundColor = "#2a2a2a" - themeColor = "#1b1b1b" - description = "Responsive card-based & code-light Hugo theme" - orientation = "portrait" - scope = "/" - -[outputFormats] - [outputFormats.MANIFEST] - mediaType = "application/json" - baseName = "manifest" - isPlainText = true - notAlternative = true - -[outputs] - home = ["HTML", "RSS", "MANIFEST"] -``` - -For more information about Hugo configuration files and all common configuration settings, please read -"[Configure Hugo](https://gohugo.io/getting-started/configuration)" from Hugo official documentation. - -### Front Matter example - -Hugo supports three formats for front matter: `yaml`, `toml` and `json`. Here is Front Matter example in YAML: - -```yaml ---- -# Common-Defined params -title: "Example article title" -date: "2017-08-21" -lastmod: "2018-12-21" -description: "Example article description" -categories: - - "Category 1" - - "Category 2" -tags: - - "Tag" - - "Another tag" -menu: main # Add page to a menu. Options: main, footer - -# Theme-Defined params -comments: true # Enable/disable Disqus comments for specific page -authorbox: true # Enable/disable Authorbox for specific page -toc: true # Enable/disable Table of Contents for specific page -tocOpen: true # Open Table of Contents block for specific page -mathjax: true # Enable/disable MathJax for specific page -related: true # Enable/disable Related content for specific page -meta: - - date - - categories - - tags -featured: - url: image.jpg # relative path of the image - alt: A scale model of the Eiffel tower # alternate text for the image - caption: Eiffel tower model # image caption - credit: Unknown author # image credit - previewOnly: false # show only preview image (true/false) ---- -``` - -For more information about front matter variables and formats read -"[Hugo Front Matter](https://gohugo.io/content-management/front-matter)" from Hugo official documentation. - -### Configuration options - -Binario includes some customizable configuration options that may be useful. - -#### Columns - -By default, Binario works with two columns card layout (if it possible by screen size) for list pages, but you can also -use one or three columns layout. Change `Params.columns`to preferable value (from 1 to 3). You can also change this -option for specific list pages in frontmatter params. - -#### Custom CSS - -If you want to include custom CSS files, you need to assign an array of references in site config file -(`config.toml` by default) like following: - -```toml -[Params] - customCSS = ["css/custom.css"] -``` - -Of course, you can reference as many CSS files as you want. Their paths need to be relative to the `static` folder of -your Hugo site: - -```toml -[Params] - customCSS = ["css/custom.css", "css/another.css"] -``` - -All custom CSS files will be added in the `head` section of a `baseof.html` right after the built-in CSS file. - -#### Custom JS - -You can add custom JavaScript files by assigning an array of references in site config file (`config.toml` by default) -like following: - -```toml -[Params] - customJS = ["js/custom.js"] -``` - -And of course, just like with custom CSS, you can reference as many JS files as you want. Their paths need to be -relative to the `static` folder of your Hugo site: - -```toml -[Params] - customJS = ["js/custom.js", "js/another.js"] -``` - -All custom JS files will be added before closing body tag of a `baseof.html` file. - -#### Entry Meta - -Entry metadata are relevant information about your entry such as published date, last modified date, category, etc. You -may activate meta fields with `meta` parameter under the `[Params.Entry]` config section: - -```toml -[Params.Entry] - meta = ["date", "categories", "tags"] -``` - -#### Related Content - -Binario uses default Related Content Hugo feature to provide "See Also"-like section. You can activate "Related Content" -section with `.Site.Params.related` parameter. - -More information available at [Hugo Related Content](https://gohugo.io/content-management/front-matter) - -#### Share Buttons - -To display share buttons, set up `[Params.Share]` specific parameters in your site config file. - -Available share buttons: Facebook, Twitter, Reddit, Telegram, LinkedIn, VK, Pocket, Pinterest - -#### Featured Image - -There are two main different ways to add a featured image for a page. - -**Option 1.** Put `featured.*` or `thumbnail.*` image file in the -[page bundle](https://gohugo.io/content-management/page-bundles/). - -**Option 2.** Put any image in the page bundle & specify `featured` param in the page's front matter. - -You may put any image in the page bundle and specify `featured` param in the page's front matter: - -```yaml -featured: image.jpg -``` - -Or you can add some additional params like `alt`, `caption`, `credit` and `previewOnly`: - -```yaml -featured: - url: image.jpg - alt: A scale model of the Eiffel tower standing on a map - caption: Eiffel tower model - credit: Unknown author - previewOnly: false -``` - -**Note**: `caption` and `credit` appear only on single pages, not summaries. - -#### Breadcrumb - -Breadcrumb navigation is a hierarchical navigation menu presented as a trail of links. The main purpose of breadcrumb is -to help users navigate in the site hierarchy. - -For enabling breadcrumb partial globally (for all single and list pages), use `enable` param under the -`[Params.Breadcrumb]` section of your config.toml file: - -```toml -[Params.Breadcrumb] - enable = true -``` - -The global `.Site.Params.Breadcrumb.enable` param can be overridden for specific pages with `breadcrumb` front matter -param: - -```yaml -breadcrumb: false -``` - -#### Footer Social Icons - -With Binario, you have the option to display social icons in the footer. To display them, set up `[Params.Social]` -specific parameters in your site config file. - -Available social services: Email, Facebook, Twitter, Telegram, Instagram, Pinterest, VK, LinkedIn, GitHub, GitLab, -Stack Overflow, Mastodon, Medium - -#### Web App Manifest - -[Web App Manifest](https://developers.google.com/web/fundamentals/web-app-manifest/) is a simple json file with basic -site info like name, description, icons, etc. This file tells the browser about your web application and how it should -behave when "installed" (as PWA) on the users mobile device or desktop. - -To activate Web App Manifest, define `MANIFEST` as custom output format and include this for `home` Kind attribute in -your site config file. Here's how to make it. - -First of all, you should define `MANIFEST` custom output format [`config.toml`]: - -```toml -[outputFormats] - [outputFormats.MANIFEST] - mediaType = "application/json" - baseName = "manifest" - isPlainText = true - notAlternative = true -``` - -Then, include `MANIFEST` output format for `home` Kind attribute [`config.toml`]: - -```toml -[outputs] - home = ["HTML", "RSS", "MANIFEST"] -``` - -After that, Web App Manifest file will be generated. Still, it's better to specify `[Params.Manifest]` params to make -sure that everything works as expected. - -| Web App Manifest Property | `.Site.Params.Manifest` Key | Default Value | Type | -| ------------------------- | --------------------------- | ------------- | ----------- | -| name | name | `.Site.Title` | required | -| short_name | shortName | `.Site.Title` | required | -| display | display | `browser` | required | -| start_url | startUrl | `/` | required | -| background_color | backgroundColor | `#2a2a2a` | recommended | -| theme_color | themeColor | `#1b1b1b` | recommended | -| description | description | | recommended | -| orientation | orientation | | recommended | -| scope | scope | | recommended | -| icons\* | | | required | - -\* You can't customize manifest icons through config params, only replacing `icons/192.png` and `icons/512.png` files. - ---- - -*To verify that your manifest file is configured properly and works well, run Hugo server and open -Chrome DevTools (Press F12 in Chrome) → Application → Manifest* - -*If you use Apache as a web server, you may have difficulty accessing files in the icons folder within your root dir. -Check [Issue #4](https://github.com/Vimux/Binario/issues/4) for more information.* - -## Contributing - -Have a bug? [Please open a new issue](https://github.com/vimux/binario/issues/new). - -Pull requests are very welcome too, but please make sure they match the existing -[contributing guide](https://github.com/vimux/binario/blob/master/CONTRIBUTING.md). - -## License - -Binario is licensed under the [MIT License](https://github.com/vimux/binario/blob/master/LICENSE). - -* Social media icons based on [SuperTinyIcons](https://github.com/edent/SuperTinyIcons) [MIT] -* CSS Reset based on [Bootstrap Reboot](https://github.com/twbs/bootstrap/blob/v4-dev/dist/css/bootstrap-reboot.css) -[MIT] diff --git a/themes/binario/exampleSite/config.toml b/themes/binario/exampleSite/config.toml deleted file mode 100755 index 7691327..0000000 --- a/themes/binario/exampleSite/config.toml +++ /dev/null @@ -1,9 +0,0 @@ -baseURL = "https://example.com/" -title = "Binario" -languageCode = "en-us" -paginate = 10 -theme = "binario" - -[Params] - description = "Responsive card-based & code-light Hugo theme" - columns = 2 diff --git a/themes/binario/exampleSite/content/about.md b/themes/binario/exampleSite/content/about.md deleted file mode 100644 index 39be931..0000000 --- a/themes/binario/exampleSite/content/about.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: About Hugo -description: Hugo, the world’s fastest framework for building websites -date: 2019-02-28 -author: Hugo Authors -menu: main ---- - -Written in Go, Hugo is an open source static site generator available under the [Apache Licence 2.0.](https://github.com/gohugoio/hugo/blob/master/LICENSE) Hugo supports TOML, YAML and JSON data file types, Markdown and HTML content files and uses shortcodes to add rich content. Other notable features are taxonomies, multilingual mode, image processing, custom output formats, HTML/CSS/JS minification and support for Sass SCSS workflows. - -Hugo makes use of a variety of open source projects including: - -* https://github.com/russross/blackfriday -* https://github.com/alecthomas/chroma -* https://github.com/muesli/smartcrop -* https://github.com/spf13/cobra -* https://github.com/spf13/viper - -Hugo is ideal for blogs, corporate websites, creative portfolios, online magazines, single page applications or even a website with thousands of pages. - -Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases. - -Websites built with Hugo are extremelly fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider. - -Learn more and contribute on [GitHub](https://github.com/gohugoio). diff --git a/themes/binario/exampleSite/content/post/basic-elements.md b/themes/binario/exampleSite/content/post/basic-elements.md deleted file mode 100644 index b826782..0000000 --- a/themes/binario/exampleSite/content/post/basic-elements.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: Basic HTML Elements -description: Example test article that contains basic HTML elements for text formatting on the Web. -date: 2019-09-24 -categories: - - "Development" -tags: - - "HTML" - - "CSS" - - "Basic Elements" ---- - -The main purpose of this article is to make sure that all basic HTML Elements are decorated with CSS so as to not miss any possible elements when creating new themes for Hugo. - - -## Headings - -Let's start with all possible headings. The HTML `
-- -According to Mozilla's website,My goal wasn't to make a ton of money. It was to build good computers. I only started the company when I realized I could be an engineer forever.
- -
Firefox 1.0 was released in 2004 and became a big success.- -## Tables - -Tables aren't part of the core Markdown spec, but Hugo supports them. - -| ID | Make | Model | Year | -| --- | --------- | ------- | ---- | -| 1 | Honda | Accord | 2009 | -| 2 | Toyota | Camry | 2012 | -| 3 | Hyundai | Elantra | 2010 | - -Colons can be used to align columns. - -| Tables | Are | Cool | -|:----------- |:-------------:| ------------:| -| align: left | align: center | align: right | -| align: left | align: center | align: right | -| align: left | align: center | align: right | - -You can also use inline Markdown. - -| Inline | Markdown | In | Table | -| ---------- | --------- | ----------------- | ---------- | -| *italics* | **bold** | ~~strikethrough~~ | `code` | - -## Code - -```html - - - - -
Test
- - -``` - -## Highlighted Code - -{{< highlight html >}} - - - - -Test
- - -{{< /highlight >}} - -## Other stuff — abbr, sub, sup, kbd, etc. - -GIF is a bitmap image format. - -H2O - -C6H12O6 - -Xn + Yn = Zn - -Press X to win. Or press CTRL+ALT+F to show FPS counter. - -As a unit of information in information theory, the bit has alternatively been called a shannon, named after Claude Shannon, the founder of field of information theory. diff --git a/themes/binario/exampleSite/content/post/creating-a-new-theme.md b/themes/binario/exampleSite/content/post/creating-a-new-theme.md deleted file mode 100644 index a585a76..0000000 --- a/themes/binario/exampleSite/content/post/creating-a-new-theme.md +++ /dev/null @@ -1,1143 +0,0 @@ ---- -title: Creating a New Theme -date: 2014-09-28 -author: Michael Henderson ---- - - -## Introduction - -This tutorial will show you how to create a simple theme in Hugo. I assume that you are familiar with HTML, the bash command line, and that you are comfortable using Markdown to format content. I'll explain how Hugo uses templates and how you can organize your templates to create a theme. I won't cover using CSS to style your theme. - -We'll start with creating a new site with a very basic template. Then we'll add in a few pages and posts. With small variations on that, you will be able to create many different types of web sites. - -In this tutorial, commands that you enter will start with the "$" prompt. The output will follow. Lines that start with "#" are comments that I've added to explain a point. When I show updates to a file, the ":wq" on the last line means to save the file. - -Here's an example: - -``` -## this is a comment -$ echo this is a command -this is a command - -## edit the file -$ vi foo.md -+++ -date = "2014-09-28" -title = "creating a new theme" -+++ - -bah and humbug -:wq - -## show it -$ cat foo.md -+++ -date = "2014-09-28" -title = "creating a new theme" -+++ - -bah and humbug -$ -``` - - -## Some Definitions - -There are a few concepts that you need to understand before creating a theme. - -### Skins - -Skins are the files responsible for the look and feel of your site. It’s the CSS that controls colors and fonts, it’s the Javascript that determines actions and reactions. It’s also the rules that Hugo uses to transform your content into the HTML that the site will serve to visitors. - -You have two ways to create a skin. The simplest way is to create it in the ```layouts/``` directory. If you do, then you don’t have to worry about configuring Hugo to recognize it. The first place that Hugo will look for rules and files is in the ```layouts/``` directory so it will always find the skin. - -Your second choice is to create it in a sub-directory of the ```themes/``` directory. If you do, then you must always tell Hugo where to search for the skin. It’s extra work, though, so why bother with it? - -The difference between creating a skin in ```layouts/``` and creating it in ```themes/``` is very subtle. A skin in ```layouts/``` can’t be customized without updating the templates and static files that it is built from. A skin created in ```themes/```, on the other hand, can be and that makes it easier for other people to use it. - -The rest of this tutorial will call a skin created in the ```themes/``` directory a theme. - -Note that you can use this tutorial to create a skin in the ```layouts/``` directory if you wish to. The main difference will be that you won’t need to update the site’s configuration file to use a theme. - -### The Home Page - -The home page, or landing page, is the first page that many visitors to a site see. It is the index.html file in the root directory of the web site. Since Hugo writes files to the public/ directory, our home page is public/index.html. - -### Site Configuration File - -When Hugo runs, it looks for a configuration file that contains settings that override default values for the entire site. The file can use TOML, YAML, or JSON. I prefer to use TOML for my configuration files. If you prefer to use JSON or YAML, you’ll need to translate my examples. You’ll also need to change the name of the file since Hugo uses the extension to determine how to process it. - -Hugo translates Markdown files into HTML. By default, Hugo expects to find Markdown files in your ```content/``` directory and template files in your ```themes/``` directory. It will create HTML files in your ```public/``` directory. You can change this by specifying alternate locations in the configuration file. - -### Content - -Content is stored in text files that contain two sections. The first section is the “front matter,” which is the meta-information on the content. The second section contains Markdown that will be converted to HTML. - -#### Front Matter - -The front matter is information about the content. Like the configuration file, it can be written in TOML, YAML, or JSON. Unlike the configuration file, Hugo doesn’t use the file’s extension to know the format. It looks for markers to signal the type. TOML is surrounded by “`+++`”, YAML by “`---`”, and JSON is enclosed in curly braces. I prefer to use TOML, so you’ll need to translate my examples if you prefer YAML or JSON. - -The information in the front matter is passed into the template before the content is rendered into HTML. - -#### Markdown - -Content is written in Markdown which makes it easier to create the content. Hugo runs the content through a Markdown engine to create the HTML which will be written to the output file. - -### Template Files - -Hugo uses template files to render content into HTML. Template files are a bridge between the content and presentation. Rules in the template define what content is published, where it's published to, and how it will rendered to the HTML file. The template guides the presentation by specifying the style to use. - -There are three types of templates: single, list, and partial. Each type takes a bit of content as input and transforms it based on the commands in the template. - -Hugo uses its knowledge of the content to find the template file used to render the content. If it can’t find a template that is an exact match for the content, it will shift up a level and search from there. It will continue to do so until it finds a matching template or runs out of templates to try. If it can’t find a template, it will use the default template for the site. - -Please note that you can use the front matter to influence Hugo’s choice of templates. - -#### Single Template - -A single template is used to render a single piece of content. For example, an article or post would be a single piece of content and use a single template. - -#### List Template - -A list template renders a group of related content. That could be a summary of recent postings or all articles in a category. List templates can contain multiple groups. - -The homepage template is a special type of list template. Hugo assumes that the home page of your site will act as the portal for the rest of the content in the site. - -#### Partial Template - -A partial template is a template that can be included in other templates. Partial templates must be called using the “partial” template command. They are very handy for rolling up common behavior. For example, your site may have a banner that all pages use. Instead of copying the text of the banner into every single and list template, you could create a partial with the banner in it. That way if you decide to change the banner, you only have to change the partial template. - -## Create a New Site - -Let's use Hugo to create a new web site. I'm a Mac user, so I'll create mine in my home directory, in the Sites folder. If you're using Linux, you might have to create the folder first. - -The "new site" command will create a skeleton of a site. It will give you the basic directory structure and a useable configuration file. - -``` -$ hugo new site ~/Sites/zafta -$ cd ~/Sites/zafta -$ ls -l -total 8 -drwxr-xr-x 7 quoha staff 238 Sep 29 16:49 . -drwxr-xr-x 3 quoha staff 102 Sep 29 16:49 .. -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 archetypes --rw-r--r-- 1 quoha staff 82 Sep 29 16:49 config.toml -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 content -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 layouts -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 static -$ -``` - -Take a look in the content/ directory to confirm that it is empty. - -The other directories (archetypes/, layouts/, and static/) are used when customizing a theme. That's a topic for a different tutorial, so please ignore them for now. - -### Generate the HTML For the New Site - -Running the `hugo` command with no options will read all the available content and generate the HTML files. It will also copy all static files (that's everything that's not content). Since we have an empty site, it won't do much, but it will do it very quickly. - -``` -$ hugo --verbose -INFO: 2014/09/29 Using config file: config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -WARN: 2014/09/29 Unable to locate layout: [404.html] -0 draft content -0 future content -0 pages created -0 tags created -0 categories created -in 2 ms -$ -``` - -The "`--verbose`" flag gives extra information that will be helpful when we build the template. Every line of the output that starts with "INFO:" or "WARN:" is present because we used that flag. The lines that start with "WARN:" are warning messages. We'll go over them later. - -We can verify that the command worked by looking at the directory again. - -``` -$ ls -l -total 8 -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 archetypes --rw-r--r-- 1 quoha staff 82 Sep 29 16:49 config.toml -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 content -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 layouts -drwxr-xr-x 4 quoha staff 136 Sep 29 17:02 public -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 static -$ -``` - -See that new public/ directory? Hugo placed all generated content there. When you're ready to publish your web site, that's the place to start. For now, though, let's just confirm that we have what we'd expect from a site with no content. - -``` -$ ls -l public -total 16 --rw-r--r-- 1 quoha staff 416 Sep 29 17:02 index.xml --rw-r--r-- 1 quoha staff 262 Sep 29 17:02 sitemap.xml -$ -``` - -Hugo created two XML files, which is standard, but there are no HTML files. - - - -### Test the New Site - -Verify that you can run the built-in web server. It will dramatically shorten your development cycle if you do. Start it by running the "server" command. If it is successful, you will see output similar to the following: - -``` -$ hugo server --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -WARN: 2014/09/29 Unable to locate layout: [404.html] -0 draft content -0 future content -0 pages created -0 tags created -0 categories created -in 2 ms -Serving pages from /Users/quoha/Sites/zafta/public -Web Server is available at http://localhost:1313 -Press Ctrl+C to stop -``` - -Connect to the listed URL (it's on the line that starts with "Web Server"). If everything is working correctly, you should get a page that shows the following: - -``` -index.xml -sitemap.xml -``` - -That's a listing of your public/ directory. Hugo didn't create a home page because our site has no content. When there's no index.html file in a directory, the server lists the files in the directory, which is what you should see in your browser. - -Let’s go back and look at those warnings again. - -``` -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -WARN: 2014/09/29 Unable to locate layout: [404.html] -``` - -That second warning is easier to explain. We haven’t created a template to be used to generate “page not found errors.” The 404 message is a topic for a separate tutorial. - -Now for the first warning. It is for the home page. You can tell because the first layout that it looked for was “index.html.” That’s only used by the home page. - -I like that the verbose flag causes Hugo to list the files that it's searching for. For the home page, they are index.html, _default/list.html, and _default/single.html. There are some rules that we'll cover later that explain the names and paths. For now, just remember that Hugo couldn't find a template for the home page and it told you so. - -At this point, you've got a working installation and site that we can build upon. All that’s left is to add some content and a theme to display it. - -## Create a New Theme - -Hugo doesn't ship with a default theme. There are a few available (I counted a dozen when I first installed Hugo) and Hugo comes with a command to create new themes. - -We're going to create a new theme called "zafta." Since the goal of this tutorial is to show you how to fill out the files to pull in your content, the theme will not contain any CSS. In other words, ugly but functional. - -All themes have opinions on content and layout. For example, Zafta uses "post" over "blog". Strong opinions make for simpler templates but differing opinions make it tougher to use themes. When you build a theme, consider using the terms that other themes do. - - -### Create a Skeleton - -Use the hugo "new" command to create the skeleton of a theme. This creates the directory structure and places empty files for you to fill out. - -``` -$ hugo new theme zafta - -$ ls -l -total 8 -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 archetypes --rw-r--r-- 1 quoha staff 82 Sep 29 16:49 config.toml -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 content -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 layouts -drwxr-xr-x 4 quoha staff 136 Sep 29 17:02 public -drwxr-xr-x 2 quoha staff 68 Sep 29 16:49 static -drwxr-xr-x 3 quoha staff 102 Sep 29 17:31 themes - -$ find themes -type f | xargs ls -l --rw-r--r-- 1 quoha staff 1081 Sep 29 17:31 themes/zafta/LICENSE.md --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/archetypes/default.md --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/list.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/single.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/index.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/footer.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/header.html --rw-r--r-- 1 quoha staff 93 Sep 29 17:31 themes/zafta/theme.toml -$ -``` - -The skeleton includes templates (the files ending in .html), license file, a description of your theme (the theme.toml file), and an empty archetype. - -Please take a minute to fill out the theme.toml and LICENSE.md files. They're optional, but if you're going to be distributing your theme, it tells the world who to praise (or blame). It's also nice to declare the license so that people will know how they can use the theme. - -``` -$ vi themes/zafta/theme.toml -author = "michael d henderson" -description = "a minimal working template" -license = "MIT" -name = "zafta" -source_repo = "" -tags = ["tags", "categories"] -:wq - -## also edit themes/zafta/LICENSE.md and change -## the bit that says "YOUR_NAME_HERE" -``` - -Note that the the skeleton's template files are empty. Don't worry, we'll be changing that shortly. - -``` -$ find themes/zafta -name '*.html' | xargs ls -l --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/list.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/_default/single.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/index.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/footer.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 themes/zafta/layouts/partials/header.html -$ -``` - - - -### Update the Configuration File to Use the Theme - -Now that we've got a theme to work with, it's a good idea to add the theme name to the configuration file. This is optional, because you can always add "-t zafta" on all your commands. I like to put it the configuration file because I like shorter command lines. If you don't put it in the configuration file or specify it on the command line, you won't use the template that you're expecting to. - -Edit the file to add the theme, add a title for the site, and specify that all of our content will use the TOML format. - -``` -$ vi config.toml -theme = "zafta" -baseurl = "" -languageCode = "en-us" -title = "zafta - totally refreshing" -MetaDataFormat = "toml" -:wq - -$ -``` - -### Generate the Site - -Now that we have an empty theme, let's generate the site again. - -``` -$ hugo --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] -0 draft content -0 future content -0 pages created -0 tags created -0 categories created -in 2 ms -$ -``` - -Did you notice that the output is different? The warning message for the home page has disappeared and we have an additional information line saying that Hugo is syncing from the theme's directory. - -Let's check the public/ directory to see what Hugo's created. - -``` -$ ls -l public -total 16 -drwxr-xr-x 2 quoha staff 68 Sep 29 17:56 css --rw-r--r-- 1 quoha staff 0 Sep 29 17:56 index.html --rw-r--r-- 1 quoha staff 407 Sep 29 17:56 index.xml -drwxr-xr-x 2 quoha staff 68 Sep 29 17:56 js --rw-r--r-- 1 quoha staff 243 Sep 29 17:56 sitemap.xml -$ -``` - -Notice four things: - -1. Hugo created a home page. This is the file public/index.html. -2. Hugo created a css/ directory. -3. Hugo created a js/ directory. -4. Hugo claimed that it created 0 pages. It created a file and copied over static files, but didn't create any pages. That's because it considers a "page" to be a file created directly from a content file. It doesn't count things like the index.html files that it creates automatically. - -#### The Home Page - -Hugo supports many different types of templates. The home page is special because it gets its own type of template and its own template file. The file, layouts/index.html, is used to generate the HTML for the home page. The Hugo documentation says that this is the only required template, but that depends. Hugo's warning message shows that it looks for three different templates: - -``` -WARN: 2014/09/29 Unable to locate layout: [index.html _default/list.html _default/single.html] -``` - -If it can't find any of these, it completely skips creating the home page. We noticed that when we built the site without having a theme installed. - -When Hugo created our theme, it created an empty home page template. Now, when we build the site, Hugo finds the template and uses it to generate the HTML for the home page. Since the template file is empty, the HTML file is empty, too. If the template had any rules in it, then Hugo would have used them to generate the home page. - -``` -$ find . -name index.html | xargs ls -l --rw-r--r-- 1 quoha staff 0 Sep 29 20:21 ./public/index.html --rw-r--r-- 1 quoha staff 0 Sep 29 17:31 ./themes/zafta/layouts/index.html -$ -``` - -#### The Magic of Static - -Hugo does two things when generating the site. It uses templates to transform content into HTML and it copies static files into the site. Unlike content, static files are not transformed. They are copied exactly as they are. - -Hugo assumes that your site will use both CSS and JavaScript, so it creates directories in your theme to hold them. Remember opinions? Well, Hugo's opinion is that you'll store your CSS in a directory named css/ and your JavaScript in a directory named js/. If you don't like that, you can change the directory names in your theme directory or even delete them completely. Hugo's nice enough to offer its opinion, then behave nicely if you disagree. - -``` -$ find themes/zafta -type d | xargs ls -ld -drwxr-xr-x 7 quoha staff 238 Sep 29 17:38 themes/zafta -drwxr-xr-x 3 quoha staff 102 Sep 29 17:31 themes/zafta/archetypes -drwxr-xr-x 5 quoha staff 170 Sep 29 17:31 themes/zafta/layouts -drwxr-xr-x 4 quoha staff 136 Sep 29 17:31 themes/zafta/layouts/_default -drwxr-xr-x 4 quoha staff 136 Sep 29 17:31 themes/zafta/layouts/partials -drwxr-xr-x 4 quoha staff 136 Sep 29 17:31 themes/zafta/static -drwxr-xr-x 2 quoha staff 68 Sep 29 17:31 themes/zafta/static/css -drwxr-xr-x 2 quoha staff 68 Sep 29 17:31 themes/zafta/static/js -$ -``` - -## The Theme Development Cycle - -When you're working on a theme, you will make changes in the theme's directory, rebuild the site, and check your changes in the browser. Hugo makes this very easy: - -1. Purge the public/ directory. -2. Run the built in web server in watch mode. -3. Open your site in a browser. -4. Update the theme. -5. Glance at your browser window to see changes. -6. Return to step 4. - -I’ll throw in one more opinion: never work on a theme on a live site. Always work on a copy of your site. Make changes to your theme, test them, then copy them up to your site. For added safety, use a tool like Git to keep a revision history of your content and your theme. Believe me when I say that it is too easy to lose both your mind and your changes. - -Check the main Hugo site for information on using Git with Hugo. - -### Purge the public/ Directory - -When generating the site, Hugo will create new files and update existing ones in the ```public/``` directory. It will not delete files that are no longer used. For example, files that were created in the wrong directory or with the wrong title will remain. If you leave them, you might get confused by them later. I recommend cleaning out your site prior to generating it. - -Note: If you're building on an SSD, you should ignore this. Churning on a SSD can be costly. - -### Hugo's Watch Option - -Hugo's "`--watch`" option will monitor the content/ and your theme directories for changes and rebuild the site automatically. - -### Live Reload - -Hugo's built in web server supports live reload. As pages are saved on the server, the browser is told to refresh the page. Usually, this happens faster than you can say, "Wow, that's totally amazing." - -### Development Commands - -Use the following commands as the basis for your workflow. - -``` -## purge old files. hugo will recreate the public directory. -## -$ rm -rf public -## -## run hugo in watch mode -## -$ hugo server --watch --verbose -``` - -Here's sample output showing Hugo detecting a change to the template for the home page. Once generated, the web browser automatically reloaded the page. I've said this before, it's amazing. - - -``` -$ rm -rf public -$ hugo server --watch --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] -0 draft content -0 future content -0 pages created -0 tags created -0 categories created -in 2 ms -Watching for changes in /Users/quoha/Sites/zafta/content -Serving pages from /Users/quoha/Sites/zafta/public -Web Server is available at http://localhost:1313 -Press Ctrl+C to stop -INFO: 2014/09/29 File System Event: ["/Users/quoha/Sites/zafta/themes/zafta/layouts/index.html": MODIFY|ATTRIB] -Change detected, rebuilding site - -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] -0 draft content -0 future content -0 pages created -0 tags created -0 categories created -in 1 ms -``` - -## Update the Home Page Template - -The home page is one of a few special pages that Hugo creates automatically. As mentioned earlier, it looks for one of three files in the theme's layout/ directory: - -1. index.html -2. _default/list.html -3. _default/single.html - -We could update one of the default templates, but a good design decision is to update the most specific template available. That's not a hard and fast rule (in fact, we'll break it a few times in this tutorial), but it is a good generalization. - -### Make a Static Home Page - -Right now, that page is empty because we don't have any content and we don't have any logic in the template. Let's change that by adding some text to the template. - -``` -$ vi themes/zafta/layouts/index.html - - - -hugo says hello!
- - -:wq - -$ -``` - -Build the web site and then verify the results. - -``` -$ hugo --verbose -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/themes/zafta/static/ to /Users/quoha/Sites/zafta/public/ -INFO: 2014/09/29 syncing from /Users/quoha/Sites/zafta/static/ to /Users/quoha/Sites/zafta/public/ -WARN: 2014/09/29 Unable to locate layout: [404.html theme/404.html] -0 draft content -0 future content -0 pages created -0 tags created -0 categories created -in 2 ms - -$ find public -type f -name '*.html' | xargs ls -l --rw-r--r-- 1 quoha staff 78 Sep 29 21:26 public/index.html - -$ cat public/index.html - - - -hugo says hello!
- -``` - -#### Live Reload - -Note: If you're running the server with the `--watch` option, you'll see different content in the file: - -``` -$ cat public/index.html - - - -hugo says hello!
- - -``` - -When you use `--watch`, the Live Reload script is added by Hugo. Look for live reload in the documentation to see what it does and how to disable it. - -### Build a "Dynamic" Home Page - -"Dynamic home page?" Hugo's a static web site generator, so this seems an odd thing to say. I mean let's have the home page automatically reflect the content in the site every time Hugo builds it. We'll use iteration in the template to do that. - -#### Create New Posts - -Now that we have the home page generating static content, let's add some content to the site. We'll display these posts as a list on the home page and on their own page, too. - -Hugo has a command to generate a skeleton post, just like it does for sites and themes. - -``` -$ hugo --verbose new post/first.md -INFO: 2014/09/29 Using config file: /Users/quoha/Sites/zafta/config.toml -INFO: 2014/09/29 attempting to create post/first.md of post -INFO: 2014/09/29 curpath: /Users/quoha/Sites/zafta/themes/zafta/archetypes/default.md -ERROR: 2014/09/29 Unable to Castmy first post
- - - - -$ cat public/post/second/index.html - - - -my second post
- - - -$ -``` - -Notice that the posts now have content. You can go to localhost:1313/post/first to verify. - -### Linking to Content - -The posts are on the home page. Let's add a link from there to the post. Since this is the home page, we'll update its template. - -``` -$ vi themes/zafta/layouts/index.html - - - - {{ range first 10 .Data.Pages }} -