diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..abc16a0 --- /dev/null +++ b/README.md @@ -0,0 +1,77 @@ +# Hinode - Template + +<!-- Tagline --> +<p align="center"> + <b>A clean documentation and blog theme for your Hugo site based on Bootstrap 5</b> + <br /> +</p> + +<!-- Badges --> +<p align="center"> + <a href="https://gohugo.io"> + <img src="https://img.shields.io/badge/generator-hugo-brightgreen" alt="Hugo website"> + </a> + <a href="https://app.netlify.com/sites/gethinode-template/deploys"> + <img src="https://img.shields.io/netlify/bbe29d40-f246-44fc-ac33-3c48e4776a11" alt="Netlify Status"> + </a> + <a href="https://stats.uptimerobot.com/xyGVYhLJmV"> + <img src="https://img.shields.io/uptimerobot/status/m793642596-ec67b9245f33e4f365f0da66" alt="UptimeRobot Status"> + </a> + <a href="https://github.com/gethinode/template/commits/main"> + <img src="https://img.shields.io/github/last-commit/gethinode/template.svg" alt="Last commit"> + </a> + <a href="https://github.com/gethinode/template/issues"> + <img src="https://img.shields.io/github/issues/gethinode/template.svg" alt="Issues"> + </a> + <a href="https://github.com/gethinode/template/pulls"> + <img src="https://img.shields.io/github/issues-pr-raw/gethinode/template.svg" alt="Pulls"> + </a> + <a href="https://github.com/gethinode/template/blob/main/LICENSE"> + <img src="https://img.shields.io/github/license/gethinode/template" alt="License"> + </a> +</p> + +## About + + + +Hinode is a clean blog theme for [Hugo][hugo], an open-source static site generator. Use this template if you would like to **take advantage of automation features**, provided by npm and GitHub actions. Visit the [docs][docs] for an alternative installation that uses Hugo only. + +## Prerequisites + +Hinode is a theme that uses [Hugo modules][hugo_modules] to install and maintain various components. The Hinode template requires the following software to be installed on your local machine. The Hugo binary itself is embedded as an npm binary. + +- [Git][git_download] +- [Go binary][golang_download] +- [Node.js][nodejs] (it includes npm) + +## Installation + +1. **Create a new repository** + + Click the button `Use this template` to initialize a new repository based on this template (log in to GitHub if needed). + +2. **Clone a local copy** + + ```bash + git clone https://github.com/owner/my-hinode-site && cd my-hinode-site # replace "owner/my-hinode-site" + ``` + +3. **Install the npm packages and hugo modules** + + ```bash + npm install && npm run mod:update + ``` + +You can now run `npm run start` to start a local development server. + +<!-- MARKDOWN LINKS --> +[docs]: https://gethinode.com/docs +[git_download]: https://git-scm.com +[golang_download]: https://go.dev/dl/ +[hugo]: https://gohugo.io +[hugo_modules]: https://gohugo.io/hugo-modules/ +[npm]: https://www.npmjs.com +[nodejs]: https://nodejs.org +[repository]: https://github.com/gethinode/hinode.git +[repository_template]: https://github.com/gethinode/template.git |