diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ef6513d..17e2bbc 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -43,7 +43,7 @@ jobs: - name: Download Bulma run: | - $Tags = git tag + $Tags = git tag | %{ $_ -replace "^v","" } Write-Output "Known Bulma tags:" $tags | Format-Table | Out-Host # get list of Bulma Releases @@ -98,10 +98,10 @@ jobs: git add assets .github git commit -m "pack Bulma $BulmaRelease for Hugo" git push --set-upstream origin $bulmaBranch - # git tag -a "$BulmaRelease" -m "packed Bulma release $BulmaRelease" + # git tag -a "v$BulmaRelease" -m "packed Bulma release $BulmaRelease" # git push --tags git checkout main gh auth login - gh release create $BulmaRelease --title "Bulma4Hugo v$BulmaRelease" --target $bulmaBranch + gh release create "v$BulmaRelease" --title "Bulma4Hugo v$BulmaRelease" --target $bulmaBranch --latest git branch -D $bulmaBranch git push origin --delete $bulmaBranch diff --git a/README.md b/README.md index 623f49b..ac1075a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# **Bulma4Hugo** - Use _Bulma_ easily within your _Hugo_ site +# **Bulma 4 Hugo** - Use _Bulma_ easily within your _Hugo_ site _Bulma_ releases packaged for use with _Hugo_ as module or using git. @@ -20,20 +20,24 @@ This is a brute force repacking of _Bulma_ release to ease up adding it to a _Hu ## Support -If you have problems/issues with _Bulma_ itself, please use the [_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 packaging may be addressed here [Bulma4Hugo](https://github.com/irkode/Bulma4Hugo) +Anything regarding packaging may be addressed here [Bulma 4 Hugo](https://github.com/irkode/bulma4hugo) -## Use Bulma4Hugo 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 your _Hugo_ site and `cd` to site root folder. -Add **Bulma\_ 4 \_Hugo** to your site using one of the below methods +Now add _Bulma 4 Hugo_ to your site using one of the below methods ### _Hugo_ module (preferred) - First [install Go](https://go.dev/doc/install) (needed for _Hugo_ modules) +- initialize your _Hugo_ site as module + + `hugo mod init your_module` + - add the module to your site config file: - _Hugo_.yaml @@ -41,42 +45,42 @@ Add **Bulma\_ 4 \_Hugo** to your site using one of the below methods ```yaml module: imports: - - path: github.com/irkode/Bulma4Hugo + - path: github.com/irkode/bulma4hugo ``` - _Hugo_.toml ```toml [module] - [module.imports] - path = github.com/irkode/Bulma4Hugo + [[module.imports]] + path = "github.com/irkode/bulma4hugo" ``` ### Git -In your site root folder choose the method you want +Add _Bulma 4 Hugo_ either using plain clone or as submodule - 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 +Add the theme to your site configuration - _Hugo_.yaml ```yaml - theme: Bulma4Hugo + theme: bulma4hugo # use array syntax if you need other themes, too theme: - - Bulma4Hugo + - bulma4hugo - othertheme ... ``` @@ -84,29 +88,34 @@ Add the Theme to your site configuration - _Hugo_.toml ```toml - theme = "Bulma4Hugo" + theme = "bulma4hugo" # use array syntax if you need other themes, too - theme = ["Bulma4Hugo", "othertheme", ...] + theme = ["bulma4hugo", "othertheme", ...] ``` ## Use _Bulma_ -After installing Bulma4Hugo you may refer to the _Bulma_ css, sass files using `/assets/_Bulma_` +After installing _Bulma 4 Hugo_ you may refer to the _Bulma_ css, sass files from `/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://go_Hugo_.io/categories/asset-management/) to add _Bulma_ tzo your site. +In general you will use [_Hugo_ Asset Management](https://gohugo.io/categories/asset-management/) to add _Bulma_ to your site. ## Releases -**Bulma\_ 4 \_Hugo** follows the _Bulma_ release scheme. So version numbers are same. - -Only tagged releases are available. +_Bulma 4 Hugo_ follows the _Bulma_ release scheme. So version numbers are same. 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_. This 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-) + +## Resources + +The Bulma CSS framework is (c) by Jeremy Thomas (jgthms) -For _Bulma_ Licensing terms consult the _Bulma_ Documentation at [_Bulma_ Licensing and Copyright](https://github.com/jgthms/_Bulma_#copyright-and-license-) +- [_Bulma_ Homepage](https://bulma.io/) +- [_Bulma_ on GitHub](https://github.com/jgthms/bulma) diff --git a/theme.toml b/theme.toml new file mode 100644 index 0000000..1652cf9 --- /dev/null +++ b/theme.toml @@ -0,0 +1,20 @@ +name = 'Bulma 4 Hugo' +license = 'MIT' +licenselink = 'https://github.com/irkode/bulma4hugo/LICENSE' +description = 'Bulma releases packaged for use with Hugo as module or using git.' + +homepage = 'https://github.com/irkode/bulma4hugo' + +authors = [ + {name = 'Irkode', homepage = 'https://www.irkdode.de'}, + {name = 'Name of author', homepage = 'Website of author'} +] +[author] + name = 'Irkode' + homepage = 'https://www.irkdode.de' + +# Not really a port, but this is origin the packed data is from +[original] + author = 'Jeremy Thomas (jgthms)' + homepage = 'https://bulma.io/' + repo = 'https://github.com/jgthms/bulma'