hugoWebsite/README.md

88 lines
3.7 KiB
Markdown
Raw Normal View History

2022-11-02 22:21:03 +01:00
<p align="center" style="padding-top:20px">
<img width="100px" src="images/logo-tailbliss-round.svg" align="center" alt="GitHub Readme Stats" />
<h1 align="center">TailBliss</h1>
<p align="center">TailBliss is an opinionated Hugo Starter with Tailwind CSS 3.2 and Alpine.js with light/dark modes.</p>
2022-11-02 22:21:03 +01:00
</p>
<p align="center">
<a href="https://github.com/nusserstudios/tailbliss/actions/">
<img alt="Tests Passing" src="https://github.com/nusserstudios/tailbliss/actions/workflows/codeql.yml/badge.svg" />
</a>
2022-11-03 01:55:01 +01:00
<a href="https://github.com/nusserstudios/tailbliss/contributors">
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/nusserstudios/tailbliss?color=0088ff" />
2022-11-02 22:21:03 +01:00
</a>
2022-11-03 01:55:01 +01:00
<a href="https://github.com/nusserstudios/tailbliss/issues">
<img alt="Issues" src="https://img.shields.io/github/issues/nusserstudios/tailbliss?color=fc0b03" />
2022-11-02 22:21:03 +01:00
</a>
2022-11-03 01:55:01 +01:00
<a href="https://github.com/nusserstudios/tailbliss/pulls">
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/nusserstudios/tailbliss?color=f97316" />
2022-11-02 22:21:03 +01:00
</a>
<a href="https://app.netlify.com/sites/tailbliss/deploys">
<img alt="Netlify Deploys" src="https://api.netlify.com/api/v1/badges/2baf2850-0f9e-49ff-833b-7b1f2db19597/deploy-status" />
</a>
2022-11-02 22:21:03 +01:00
<br />
<br />
<a href="https://gohugo.io/">
<img src="https://img.shields.io/badge/Hugo%20-0.105.0%20-gray.svg?colorA=c9177e&colorB=FF4088&style=for-the-badge"/>
</a>
<a href="https://tailwindcss.com/">
<img src="https://img.shields.io/badge/TailwindCSS%20-V3-gray.svg?colorA=0284c7&colorB=38bdf8&style=for-the-badge"/>
2022-11-02 22:21:03 +01:00
</a>
<a href="https://alpinejs.dev/">
<img src="https://img.shields.io/badge/Alpine.js%20-V3-gray.svg?colorA=68a5af&colorB=77c1d2&style=for-the-badge"/>
2022-11-02 22:21:03 +01:00
</a>
</p>
<p align="center">
<a href="https://tailbliss.netlify.app/">View Demo</a>
2022-11-02 22:21:03 +01:00
·
2022-11-03 01:55:01 +01:00
<a href="https://github.com/nusserstudios/tailbliss/issues">Report Bug</a>
2022-11-02 22:21:03 +01:00
·
<a href="https://github.com/nusserstudios/tailbliss/discussions/categories/feature-request">Request Feature</a>
2022-11-02 22:21:03 +01:00
·
2022-11-03 01:55:01 +01:00
<a href="https://github.com/nusserstudios/tailbliss/discussions/categories/general">Ask Question</a>
2022-11-02 22:21:03 +01:00
</p>
</p>
2022-11-03 23:44:46 +01:00
<p align="center">
<img src="https://raw.githubusercontent.com/nusserstudios/tailbliss/main/images/tailbliss-lighthouse-11-03-22.png" alt="Tailbliss Google Lighthouse Score" style="margin: 25px auto; max-width: 830px" width="100%" height="" />
2022-11-03 23:33:51 +01:00
</p>
2022-10-29 00:20:35 +02:00
**Install to VS Code with:**
2022-11-10 15:46:59 +01:00
`git clone git@github.com:nusserstudios/tailbliss your-name`
2022-10-30 18:27:03 +01:00
2022-10-30 19:08:03 +01:00
##### Install with NPM
2022-10-29 00:20:35 +02:00
`npm install`
2022-10-30 19:08:03 +01:00
##### Install with Yarn
2022-10-30 18:27:52 +01:00
`yarn`
2022-10-29 00:20:35 +02:00
2022-10-29 21:11:03 +02:00
**To start developing:**
2022-10-30 19:08:03 +01:00
##### Develop with NPM
2022-10-29 00:20:35 +02:00
`npm run start`
2022-10-30 19:08:03 +01:00
##### Develop with Yarn
2022-10-29 00:20:35 +02:00
`yarn start`
2022-10-29 21:11:03 +02:00
**To generate the site HTML:**
2022-10-30 19:08:03 +01:00
##### Build with NPM
2022-10-29 00:20:35 +02:00
`npm run build`
2022-10-30 19:08:03 +01:00
##### Build with Yarn
2022-10-29 00:20:35 +02:00
`yarn build`
**npm run start** will run two commands parallel:
`npx tailwindcss -i ./assets/css/main.css -o ./assets/css/style.css --watch`
2022-10-29 14:54:48 +02:00
Has paginated Categories and Tags. Markdown files will automatically convert images put into `/assets` folder to .webp images.
## Image shortcodes for webp as well.
{{< imgh src="img-name.jpg" alt="Place alt text here." >}}
2022-10-29 00:20:35 +02:00
2022-10-29 14:54:48 +02:00
<a href="https://www.buymeacoffee.com/nusserstudios" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-blue.png" alt="Buy Me A Coffee" height="41" width="174"></a>
2022-10-29 00:20:35 +02:00
## Credits
4044ever - Original Theme
https://github.com/4044ever/Hugo-Tailwind-3.0.git
Jan Heise - Alpine.js Navbar
https://github.com/jan-heise/responsive-navbar-with-dropdown
Made for Hacktoberfest, with ❤️ by NusserStudios.