diff --git a/README.md b/README.md index 852f830..93e1959 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,55 @@ -# _Bulma 4 Hugo_ - Use Bulma easily within your Hugo site +# **Bulma4Hugo** - Use _Bulma_ easily within your _Hugo_ site -Bulma releases packaged for use with Hugo as module or using git. +_Bulma_ releases packaged for use with _Hugo_ as module or using git. ## Features -- access to all build variants from Bulma release. +- access to all build variants from _Bulma_ release. - choose a precompiled CSS variant -- use the SCSS and your build pipeline - - customize SCSS if you want -- easy version change depending on your chosen usage +- use the SASS and your build pipeline + - customize SASS if you want +- easy version change (depending on your chosen usage) ## Disclaimer -This is just a brute force repacking Bulma release for using as a Hugo module. +This is a brute force repacking of _Bulma_ release to ease up adding it to a _Hugo_ site. - There's no stuff like verification and testing. - delivered as-is, no guarantee no warranty -- No Bulma support here +- No _Bulma_ support here ## Support -If you have problems/issues with Bulma itself, please use [Bulma issue tracker](https://github.com/jgthms/bulma/issues). +If you have problems/issues with _Bulma_ itself, please use the [_Bulma_ issue tracker](https://github.com/jgthms/_Bulma_/issues). -anything regarding the packaging may be addressed here [Bulma 4 Hugo](https://github.com/irkode/bulma4hugo) +Anything regarding packaging may be addressed here [_Bulma_ 4 _Hugo_](https://github.com/irkode/Bulma4Hugo) -## Use Bulma 4 Hugo in your Hugo project +## Use _Bulma_ 4 _Hugo_ in your _Hugo_ project -Set up a you Hugo site and cd to site root folder. +Set up a you _Hugo_ site and `cd` to site root folder. -Add _Bulma 4 Hugo_ to your site using one of the below methods +Add **Bulma\_ 4 \_Hugo** to your site using one of the below methods -### Hugo module (preferred) +### _Hugo_ module (preferred) -- First [install Go](https://go.dev/doc/install) (needed for hugo modules) +- First [install Go](https://go.dev/doc/install) (needed for _Hugo_ modules) - add the module to your site config file: - - hugo.yaml + - _Hugo_.yaml ```yaml module: imports: - - path: github.com/irkode/bulma4hugo + - path: github.com/irkode/Bulma4Hugo ``` - - hugo.toml + - _Hugo_.toml ```toml [module] [module.imports] - path = github.com/irkode/bulma4hugo + path = github.com/irkode/Bulma4Hugo ``` ### Git @@ -59,54 +59,54 @@ In your site root folder choose the method you want - Clone ``` - git clone https://github.com/irkode/bulma4hugo.git themes/bulma4hugo + git clone https://github.com/irkode/Bulma4Hugo.git themes/Bulma4Hugo ``` - Submodule ``` - git submodule add https://github.com/irkode/bulma4hugo.git themes/bulma4hugo + git submodule add https://github.com/irkode/Bulma4Hugo.git themes/Bulma4Hugo ``` Add the Theme to your site configuration -- hugo.yaml +- _Hugo_.yaml ```yaml - theme: bulma4hugo + theme: Bulma4Hugo # use array syntax if you need other themes, too theme: - - bulma4hugo + - Bulma4Hugo - othertheme ... ``` -- hugo.toml +- _Hugo_.toml ```toml - theme = "bulma4hugo" + theme = "Bulma4Hugo" # use array syntax if you need other themes, too - theme = ["bulma4hugo", "othertheme", ...] + theme = ["Bulma4Hugo", "othertheme", ...] ``` -## Use Bulma +## Use _Bulma_ -After installing Bulma 4 Hugo you may refer to the Bulma css, scss files using `/assets/bulma` +After installing _Bulma_ 4 _Hugo_ you may refer to the _Bulma_ css, sass files using `/assets/_Bulma_` -Just follow the [Official Bulma documentation](https://bulma.io/). +Just follow the [Official _Bulma_ documentation](https://_Bulma_.io/). -In general you will use [Hugo Asset Management](https://gohugo.io/categories/asset-management/) to add Bulma tzo your site. +In general you will use [_Hugo_ Asset Management](https://go_Hugo_.io/categories/asset-management/) to add _Bulma_ tzo your site. ## Releases -_Bulma 4 Hugo_ follows the Bulma release scheme. So version numbers are same. +**Bulma\_ 4 \_Hugo** follows the _Bulma_ release scheme. So version numbers are same. Only tagged releases are available. -New Bulma releases should be added shortly after published. +New _Bulma_ releases should be added shortly after published. ## Licensing -This is just a repack of Bulma. The packer itself is [MIT licensed](./LICENSE) +This is just a repack of _Bulma_. The packer itself is [MIT licensed](./LICENSE) -For Bulma Licensing terms consult the Bulma Documentation at [Bulma Licensing and Copyright](https://github.com/jgthms/bulma#copyright-and-license-) +For _Bulma_ Licensing terms consult the _Bulma_ Documentation at [_Bulma_ Licensing and Copyright](https://github.com/jgthms/_Bulma_#copyright-and-license-)