An open API service indexing awesome lists of open source software.

https://github.com/dxrcy/recipes

Recipe website
https://github.com/dxrcy/recipes

Last synced: 2 months ago
JSON representation

Recipe website

Awesome Lists containing this project

README

        

# Ibex Template

Simple template for an [Ibex](https://github.com/darccyy/ibex) SSG site.

- [Live on GitHub Pages](https://darccyy.github.io/ibex-template)

# Usage

```sh
# Clone the repo
git clone https://github.com/darccyy/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

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.

# 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

![Ibex logo](static/icon.png)