hugoWebsite/README.md

60 lines
2.0 KiB
Markdown
Raw Normal View History

2023-10-03 11:51:48 +02:00
<h1 align="center">NewPipe e.V. website</h1>
2022-11-03 23:44:46 +01:00
<p align="center">
2023-10-03 11:51:48 +02:00
<br>
<br>
<a href="https://gohugo.io/">
2023-10-08 21:54:27 +02:00
<img src="https://img.shields.io/badge/Hugo%20-gray.svg?colorA=c9177e&colorB=FF4088&style=for-the-badge" alt="Hugo"/>
2023-10-03 11:51:48 +02:00
</a>
<a href="https://tailwindcss.com/">
2023-10-08 21:54:27 +02:00
<img src="https://img.shields.io/badge/TailwindCSS%20-V3-gray.svg?colorA=0284c7&colorB=38bdf8&style=for-the-badge" alt="TailwindCSS 3"/>
2023-10-03 11:51:48 +02:00
</a>
<a href="https://alpinejs.dev/">
2023-10-08 21:54:27 +02:00
<img src="https://img.shields.io/badge/Alpine.js%20-V3-gray.svg?colorA=68a5af&colorB=77c1d2&style=for-the-badge" alt="ALpine.js 3"/>
2023-10-03 11:51:48 +02:00
</a>
2022-11-03 23:33:51 +01:00
</p>
2023-10-03 11:51:48 +02:00
## Prerequisites
- [Hugo __*extended*__ version](https://gohugo.io/getting-started/installing/)
- [npm / nodejs](https://nodejs.org/en/download/) or [yarn](https://yarnpkg.com/getting-started/install)
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.
2023-07-25 01:18:15 +02:00
{{< imgc src="img-name.jpg" alt="Place alt text here." >}}
2022-10-29 00:20:35 +02:00
## Form
2023-08-12 16:43:26 +02:00
To use the form, visit [FormSubmit.Co](https://formsubmit.co/). Locate the contact form in "content/contact.md", and update the form action with the email address you want on this line: **action="https://formsubmit.co/your@email.com" method="POST"**
## 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
2023-10-03 11:51:48 +02:00
Tailbliss theme by NusserStudios.
https://github.com/nusserstudios/tailbliss/
Made for Hacktoberfest, with ❤️ by NusserStudios.