diff options
author | Shohei Ueda <30958501+peaceiris@users.noreply.github.com> | 2020-09-20 15:51:21 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-09-20 15:51:21 +0300 |
commit | 90f4fe5d92e0bae8cb413b239bca31e00cd78c93 (patch) | |
tree | 5d7522656035498bb1886ea56f8edc2fb205fcba /README.md | |
parent | baa251c1edbbd918b48620d05385c821546a8c89 (diff) |
feat: github-sponsors-list shortcode (#197)
* feat: github-sponsors-list shortcode
* update image
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 24 |
1 files changed, 20 insertions, 4 deletions
@@ -44,6 +44,7 @@ Hugo IRIS Theme - [li](#li) - [mermaid](#mermaid) - [repo](#repo) + - [github-sponsors-list](#github-sponsors-list) - [table](#table) - [How to Update the Theme](#how-to-update-the-theme) - [Git submodule](#git-submodule) @@ -261,18 +262,23 @@ sequenceDiagram ### repo Run the following script to get the latest repository data. +The script requires the [gh] command. + +[gh]: https://github.com/cli/cli For more details: [scripts/fetch_data.sh](./exampleSite/scripts/fetch_data.sh) ```sh +brew install gh +gh auth login +``` + +```sh cd ./your_hugo_project -export GH_PAT="github_personal_access_token" export GH_USER_ID="peaceiris" -bash ./scripts/fetch_data.sh "${GH_PAT}" "${GH_USER_ID}" | jq . > "./data/github/${GH_USER_ID}.json" +bash ./scripts/fetch_data.sh "${GH_USER_ID}" > "./data/github/${GH_USER_ID}.json" ``` -Using `jq` is optional. - We can show a repository card like as follows. ```md @@ -283,6 +289,16 @@ We can show a repository card like as follows. <img width="500px" src="https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/exampleSite/static/images/shortcode_repo.jpg" alt="Shortcode repo"> +### github-sponsors-list + +Please follow the instruction as the same as the `repo` shortcode. + +```md +{{< github-sponsors-list id="peaceiris" >}} +``` + +<img width="500px" src="https://raw.githubusercontent.com/peaceiris/hugo-theme-iris/master/exampleSite/static/images/shortcode_github-sponsors-list.jpg" alt="Shortcode github-sponsors-list"> + ### table ```md |