mirrors/binario
1
0
Fork 0
mirror of https://github.com/Vimux/Binario.git synced 2024-09-21 14:39:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source 
Grammar fixes for clarity
This commit is contained in:
John Paul Wohlscheid 2024-08-13 22:49:19 -04:00 committed by GitHub
parent e4bab35fd1
commit 7c9b648e52
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 33 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

66
README.md
View file

@ -43,14 +43,14 @@
*First of all, you will need to [install Hugo](https://gohugo.io/getting-started/quick-start/#step-1-install-hugo) and *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 [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**.* installed on your machine and are familiar with basic git usage. After that, you are ready to install **Binario**.*
There are three different ways you can install **Binario**. Choose one of the installation methods listed below and There are three different ways you can install **Binario**. Choose one of the installation methods listed below and
follow the instructions. follow the instructions.
- **A**. [Git clone](#option-a-git-clone) - **A**. [Git clone](#option-a-git-clone)
- **B**. [Git submodule](#option-b-git-submodule) - **B**. [Git submodule](#option-b-git-submodule)
- **C**. [Download ZIP and manual install](#option-c-download-zip-and-manual-install) - **C**. [Download ZIP and manually 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/)"*. *For more information read the "[Install and Use Themes](https://gohugo.io/themes/installing-and-using-themes/)"*.
@ -62,7 +62,7 @@ In your Hugo site directory, run:
git clone https://github.com/vimux/binario themes/binario git clone https://github.com/vimux/binario themes/binario
``` ```
Next, edit your `config.toml` configuration file and add parameter: Next, edit your `config.toml` configuration file and add the parameter:
```toml ```toml
theme = "binario" theme = "binario"
@ -76,7 +76,7 @@ In your Hugo site directory, run:
git submodule add https://github.com/vimux/binario themes/binario git submodule add https://github.com/vimux/binario themes/binario
``` ```
Next, edit your `config.toml` configuration file and add parameter: Next, edit your `config.toml` configuration file and add the parameter:
```toml ```toml
theme = "binario" theme = "binario"
@ -85,12 +85,12 @@ theme = "binario"
*You can [read the GitHub documentation for submodules](https://github.com/blog/2104-working-with-submodules) or those *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* 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 ### Option C. Download ZIP and manually install
**[Download ZIP](https://github.com/vimux/binario/archive/master.zip)** and extract to the `themes/binario` within your **[Download ZIP](https://github.com/vimux/binario/archive/master.zip)** and extract to the `themes/binario` within your
Hugo website. Hugo website.
Next, edit your `config.toml` configuration file and add parameter: Next, edit your `config.toml` configuration file and add the parameter:
```toml ```toml
theme = "binario" theme = "binario"
@ -106,7 +106,7 @@ hugo server
Now you can go to [localhost:1313](http://localhost:1313) webpage and the Binario theme should be visible. 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 After you make sure that **Binario** works, you may start customizing the theme as needed. You can change
[number of columns](#columns), activate [footer social icons](#footer-social-icons), [share buttons](#share-buttons) and [number of columns](#columns), activate [footer social icons](#footer-social-icons), [share buttons](#share-buttons) and
[much more](#configuration-options). [much more](#configuration-options).
@ -137,12 +137,12 @@ googleAnalytics = "" # DEPRECATED! Use .Services.googleAnalytics.ID
avatar = "img/avatar.png" avatar = "img/avatar.png"
[Params] [Params]
description = "Responsive card-based & code-light Hugo theme" # Site Description. Used in meta description description = "Responsive card-based & code-light Hugo theme" # Site Description. Used in the meta description
copyright = "Binario" # Copyright holder, otherwise will use .Site.Title copyright = "Binario" # Copyright holder, otherwise will use .Site.Title
opengraph = true # Enable OpenGraph if true opengraph = true # Enable OpenGraph if true
schema = true # Enable Schema schema = true # Enable Schema
twitter_cards = true # Enable Twitter Cards if true twitter_cards = true # Enable Twitter Cards if true
columns = 2 # Set the number of cards columns. Possible values: 1, 2, 3 columns = 2 # Set the number of card columns. Possible values: 1, 2, 3
mainSections = ["post"] # Set main page sections mainSections = ["post"] # Set main page sections
dateFormat = "January 02, 2006" # Change the format of dates dateFormat = "January 02, 2006" # Change the format of dates
colorTheme = "" # dark-green, dark-blue, dark-red, dark-violet colorTheme = "" # dark-green, dark-blue, dark-red, dark-violet
@ -152,11 +152,11 @@ googleAnalytics = "" # DEPRECATED! Use .Services.googleAnalytics.ID
authorbox = true # Show authorbox at bottom of single pages if true authorbox = true # Show authorbox at bottom of single pages if true
comments = true # Enable comments for all site pages comments = true # Enable comments for all site pages
related = true # Enable Related content for single 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 relatedMax = 5 # Set the maximum number of elements that can be displayed in a related block. Optional
mathjax = true # Enable MathJax for all site pages 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 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 mathjaxConfig = "TeX-AMS-MML_HTMLorMML" # Specify MathJax config. Optional
hideNoPostsWarning = false # Don't show no posts empty state warning in main page, if true hideNoPostsWarning = false # Don't show no posts empty state warning in the main page, if true
[Params.Entry] [Params.Entry]
meta = ["date", "categories", "tags"] # Enable meta fields in given order meta = ["date", "categories", "tags"] # Enable meta fields in given order
@ -225,7 +225,7 @@ For more information about Hugo configuration files and all common configuration
### Front Matter example ### Front Matter example
Hugo supports three formats for front matter: `yaml`, `toml` and `json`. Here is Front Matter example in YAML: Hugo supports three formats for front matter: `yaml`, `toml`, and `json`. Here is a Front Matter example in YAML:
```yaml ```yaml
--- ---
@ -271,13 +271,13 @@ Binario includes some customizable configuration options that may be useful.
#### Columns #### Columns
By default, Binario works with two columns card layout (if it possible by screen size) for list pages, but you can also By default, Binario works with two columns card layout (if 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 use a one or three columns layout. Change `Params.columns` to a preferable value (from 1 to 3). You can also change this
option for specific list pages in frontmatter params. option for specific list pages in frontmatter params.
#### Custom CSS #### Custom CSS
If you want to include custom CSS files, you need to assign an array of references in site config file If you want to include custom CSS files, you need to assign an array of references in the site config file
(`config.toml` by default) like following: (`config.toml` by default) like following:
```toml ```toml
@ -297,7 +297,7 @@ All custom CSS files will be added in the `head` section of a `baseof.html` righ
#### Custom JS #### Custom JS
You can add custom JavaScript files by assigning an array of references in site config file (`config.toml` by default) You can add custom JavaScript files by assigning an array of references in the site config file (`config.toml` by default)
like following: like following:
```toml ```toml
@ -313,12 +313,12 @@ relative to the `static` folder of your Hugo site:
customJS = ["js/custom.js", "js/another.js"] customJS = ["js/custom.js", "js/another.js"]
``` ```
All custom JS files will be added before closing body tag of a `baseof.html` file. All custom JS files will be added before closing the body tag of a `baseof.html` file.
#### Entry Meta #### Entry Meta
Entry metadata are relevant information about your entry such as published date, last modified date, category, etc. You 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: may activate meta fields with the `meta` parameter under the `[Params.Entry]` config section:
```toml ```toml
[Params.Entry] [Params.Entry]
@ -327,10 +327,10 @@ may activate meta fields with `meta` parameter under the `[Params.Entry]` config
#### Related Content #### Related Content
Binario uses default Related Content Hugo feature to provide "See Also"-like section. You can activate "Related Content" Binario uses the default Related Content Hugo feature to provide a "See Also"-like section. You can activate "Related Content"
section with `.Site.Params.related` parameter. section with `.Site.Params.related` parameter.
More information available at [Hugo Related Content](https://gohugo.io/content-management/front-matter) More information is available at [Hugo Related Content](https://gohugo.io/content-management/front-matter)
#### Share Buttons #### Share Buttons
@ -340,20 +340,20 @@ Available share buttons: Facebook, Twitter, Reddit, Telegram, LinkedIn, VK, Pock
#### Featured Image #### Featured Image
There are two main different ways to add a featured image for a page. There are two main ways to add a featured image for a page.
**Option 1.** Put `featured.*` or `thumbnail.*` image file in the **Option 1.** Put `featured.*` or `thumbnail.*` image file in the
[page bundle](https://gohugo.io/content-management/page-bundles/). [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. **Option 2.** Put any image in the page bundle & specify the `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: You may put any image in the page bundle and specify the `featured` param in the page's front matter:
```yaml ```yaml
featured: image.jpg featured: image.jpg
``` ```
Or you can add some additional params like `alt`, `caption`, `credit` and `previewOnly`: Or you can add some additional params like `alt`, `caption`, `credit`, and `previewOnly`:
```yaml ```yaml
featured: featured:
@ -369,9 +369,9 @@ featured:
#### Breadcrumb #### Breadcrumb
Breadcrumb navigation is a hierarchical navigation menu presented as a trail of links. The main purpose of breadcrumb is 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. to help users navigate the site hierarchy.
For enabling breadcrumb partial globally (for all single and list pages), use `enable` param under the For enabling breadcrumb partial globally (for all single and list pages), use the `enable` param under the
`[Params.Breadcrumb]` section of your config.toml file: `[Params.Breadcrumb]` section of your config.toml file:
```toml ```toml
@ -396,14 +396,14 @@ Stack Overflow, Mastodon, Medium
#### Web App Manifest #### Web App Manifest
[Web App Manifest](https://developers.google.com/web/fundamentals/web-app-manifest/) is a simple json file with basic [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 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. behave when "installed" (as PWA) on the user's mobile device or desktop.
To activate Web App Manifest, define `MANIFEST` as custom output format and include this for `home` Kind attribute in To activate Web App Manifest, define `MANIFEST` as a custom output format and include this for the `home` Kind attribute in
your site config file. Here's how to make it. your site config file. Here's how to make it.
First of all, you should define `MANIFEST` custom output format [`config.toml`]: First of all, you should define the `MANIFEST` custom output format in [`config.toml`]:
```toml ```toml
[outputFormats] [outputFormats]
@ -414,14 +414,14 @@ First of all, you should define `MANIFEST` custom output format [`config.toml`]:
notAlternative = true notAlternative = true
``` ```
Then, include `MANIFEST` output format for `home` Kind attribute [`config.toml`]: Then, include the `MANIFEST` output format for the `home` Kind attribute [`config.toml`]:
```toml ```toml
[outputs] [outputs]
home = ["HTML", "RSS", "MANIFEST"] home = ["HTML", "RSS", "MANIFEST"]
``` ```
After that, Web App Manifest file will be generated. Still, it's better to specify `[Params.Manifest]` params to make After that, a Web App Manifest file will be generated. Still, it's better to specify `[Params.Manifest]` params to make
sure that everything works as expected. sure that everything works as expected.
| Web App Manifest Property | `.Site.Params.Manifest` Key | Default Value | Type | | Web App Manifest Property | `.Site.Params.Manifest` Key | Default Value | Type |
@ -441,7 +441,7 @@ sure that everything works as expected.
--- ---
*To verify that your manifest file is configured properly and works well, run Hugo server and open *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* 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. *If you use Apache as a web server, you may have difficulty accessing files in the icons folder within your root dir.