https://github.com/dashpilot/html-kit
https://github.com/dashpilot/html-kit
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dashpilot/html-kit
- Owner: dashpilot
- Created: 2024-10-08T13:01:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-17T15:05:53.000Z (over 1 year ago)
- Last Synced: 2024-12-27T01:12:19.591Z (over 1 year ago)
- Language: CSS
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# html-kit
Html-kit is a nodejs build script to give plain html superpowers. It adds:
- **html includes** - you can now simply include other HTML files/partials into your index.html
- **html components** - each partial can contain css and js which is split out into separate components.css and components.js files. So you can use html, css and js in one file.
- **live preview and hot reload** - Html-kit comes with a built-in webserver and automatically reloads every time you make changes
Take a look at `src/index.html` and `src/components.html` to see how (simple) it all works.
## HTML includes
To include a file:
```
{{include "components/my-component.html"}}
```
# How to install?
You can download this repo, and use it as the basis for your new project, or you can use Degit to download the files to your current working directory:
```bash
npm install -g degit
degit https://github.com/dashpilot/html-kit
```
To run it:
```
npm install
npm run dev
```
This will start a dev server at localhost:3000 and will watch your `src` folder for changes.