hugoWebsite/README.md

45 lines
1.4 KiB
Markdown
Raw Normal View History

2022-11-01 17:38:23 +01:00
![Tailbliss]((https://github.com/nusserstudios/tailbliss/blob/main/static/images/tailbliss-full-blue.png)
2022-10-29 01:17:43 +02:00
# TailBliss
Hugo + TailwindCSS 3.2.0 + Alpine.js for Hacktoberfest
2022-10-29 00:20:35 +02:00
2022-10-29 21:09:23 +02:00
TailBliss is an opinionated Hugo Starter with Tailwind CSS 3.2 and Alpine.js with light/dark modes.
2022-10-29 00:20:35 +02:00
**Install to VS Code with:**
2022-10-29 21:11:03 +02:00
`git clone git@github.com:nusserstudios/hugo-twcss-alpine.git 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
2022-10-29 14:54:48 +02:00
Made for Hacktoberfest, with ❤️ by NusserStudios.