https://github.com/dxrcy/ibex-template
Simple template for an Ibex SSG site
https://github.com/dxrcy/ibex-template
Last synced: 3 months ago
JSON representation
Simple template for an Ibex SSG site
- Host: GitHub
- URL: https://github.com/dxrcy/ibex-template
- Owner: dxrcy
- License: gpl-3.0
- Created: 2023-10-17T09:21:24.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-02T02:07:33.000Z (over 1 year ago)
- Last Synced: 2025-03-15T08:37:16.758Z (3 months ago)
- Language: Rust
- Homepage:
- Size: 111 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ibex Template
Simple template for an [Ibex](https://github.com/dxrcy/ibex) SSG site.
- [Live on GitHub Pages](https://dxrcy.dev/ibex-template)
# Usage
```sh
# Clone the repo
git clone https://github.com/dxrcy/ibex-template my-ibex-app
cd my-ibex-app
git remote remove origin
# Install some dev dependencies
cargo install just cargo-watch basic-http-server
# Build and open a local server on localhost:4000
just serve
```
## GitHub Pages Setup
### Deploy from branch (Default method)
GitHub will automatically build to the `gh-pages` branch, with the `deploy.yaml` Action. The action will automatically run when the repository is initially cloned.
In repository settings, navigate to the `Pages` tab, and change 'Branch' to `gh-pages`. GitHub pages will automatically update, and the website should be live soon.
### *Beta* GitHub Action (Alternate method)
> This section is missing, but you can see [https://github.com/dxrcy/garfeo](this repository) for a working example.
# File structure
No Rust code is included in the website itself. It is just for compilation.
- Everything is compiled to `/build` (except `/target`)
- Source files are included in `/src`
- `/src` is the Rust binary source folder
- `/src/scss` will be compiled to css and written to `/build/css`
- `/src/js` can be used to `include_str!` Javascript code into templates
- Static files (such as images or assets) are found in `/static`, and are copied directly into `/build/static`
- `/static` may be symlinked in development mode (for compilation speed), but never in production
