Skip to content

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fTrestour committed Oct 26, 2024
1 parent d343b0c commit e6916e8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,30 @@
This is a static site builder using Bun, Tailwind CSS, and @kitajs/html.
It focuses on simplicity, while providing a modern component-driven development experience.

## Getting Started

Create your own repository by using this repository as a template:
![Use this template](./assets/create.png)

## File Structure

The repository is organized as follows:
The is organized as follows:

- `src/build.ts`: This is the file that builds your website. You shouldn't need to modify it.
- `src/pages/`: This directory hosts the site pages. Each `.tsx` file in this directory represents a page, and the default export of each file will be the page content.
- `dist`: Your site is built there.
- `src/styles.css`: This is the source Tailwind CSS file where you can add and customize your styles.
- `src/layout.tsx`: This file contains the base structure to render all your pages. It includes the meta header and other common elements shared across all pages.
- **`src/build.ts`**: This is the file that builds your website. You shouldn't need to modify it.
- **`src/pages/`**: This directory hosts the site pages. Each `.tsx` file in this directory represents a page, and the default export of each file will be the page content.
- **`dist`**: Your site is built there.
- **`src/styles.css`**: This is the source Tailwind CSS file where you can add and customize your styles.
- **`src/layout.tsx`**: This file contains the base structure to render all your pages. It includes the meta header and other common elements shared across all pages.

## Github Actions

This project uses GitHub Actions to:
- Test the build is not broken when pushing on any branch.
- Create a release containing the built website in an archive file - both `.tar.gz` and `zip` - when pushing on `main`
- Pull updates from the template repository into your project. To do that : "Actions" > "Template update" > "Run workflow". To have it work properly, you should update workflow permissions beforehand in "Settings" > "Actions" > "General", like so:
- **Test the build** is not broken when pushing on any branch.
- **Create a release** containing the built website in an archive file - both `.tar.gz` and `zip` - when pushing on `main`
- **Pull updates from the template repository** into your own project and creates a PR for the update. By default, updates are fetched once a day. They can also be triggered manually : "Actions" > "Template update" > "Run workflow". To have this behaviour work properly, you should update workflow permissions beforehand in "Settings" > "Actions" > "General", like so:
![Needed permissions](./assets/permissions.png)

## Getting Started
## Create your amazing website!

### Prerequisites

Expand All @@ -44,9 +49,6 @@ To start the development server, which watches for changes in your TypeScript an
```bash
bun dev
```



## Todo

- [ ] Imports validation?
Expand All @@ -55,6 +57,5 @@ bun dev
- [ ] analytics?
- [ ] CI that makes a report on the built site diff?
- [ ] Improve error handling for the build, make error messages foolproof
- [ ] Add a Github action for [auto-update](https://0xdc.me/blog/github-templates-and-repository-sync/)?
- [ ] Handle 404
- [ ] Improve default Home
Binary file added assets/create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e6916e8

Please sign in to comment.