Cleanup, sort and update README

This commit is contained in:
2025-05-30 14:34:18 -04:00
parent 5aa6e7f944
commit ccad95ef02
2 changed files with 46 additions and 35 deletions

View File

@@ -1 +1,24 @@
## Hugo tags generator
## Hugo help tags generator
### Usage
1. Install dependency: https://mikefarah.gitbook.io/yq/
2. Clone hugo docs and checkout to your hugo version
```bash
git clone https://github.com/gohugoio/hugoDocs/
git checkout v0.147.5
```
3. Generate tags
```bash
cd /path/to/your/hugo/website
hugotags.sh /path/to/cloneOf/hugoDocs/content/en > tags
```
### vim
All tag commands and mapping works good. The one I use often are below
* `Ctrl w Ctrl ]` => Open the tag in horizontal split
* `Ctrl w g Ctrl ]` => Same as above but if there are more than one tag, shows
a list instead going to the first one