README.md (view raw)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 |
# Kushiyaki ## Installation 1. Create a project directory 2. `bun init` 3. `bun add kushiyaki` 4. `bun add hastx` 5. `curl https://codeberg.org/trickyni/kushiyaki/raw/branch/main/bunfig.toml > bunfig.toml` 6. `bunx kushiyaki` ## usage - Create `input` folder in the project's root directory, and populate it with markdown files and assets - Use `bunx kushiyaki` to process the files into an `out` folder ### local server - `bunx kushiyaki run dev` to deploy a local version of the website using [caddy](https://caddyserver.com/) at <https://localhost:3001> - Use `caddy stop` to remove the server (will be changed to an autoreload) ### write to personal website - Replace `!<URL OF WEBSITE>` in `package.json` `scripts: "deploy"` with the ssh path for the server in which your website is hosted - `bunx kushiyaki run deply` will automatically `rsync` the newly written "out" folder into that path |