Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sebastienrousseau/kaishi.github.io
Make beautiful websites with Kaishi, a Shokunin (職人) Static Site Generator starter template.
https://github.com/sebastienrousseau/kaishi.github.io
html-template html5-template shokunin static-site
Last synced: about 1 month ago
JSON representation
Make beautiful websites with Kaishi, a Shokunin (職人) Static Site Generator starter template.
- Host: GitHub
- URL: https://github.com/sebastienrousseau/kaishi.github.io
- Owner: sebastienrousseau
- License: apache-2.0
- Created: 2023-05-27T21:19:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-05T20:32:49.000Z (about 1 year ago)
- Last Synced: 2024-05-02T03:01:25.644Z (7 months ago)
- Topics: html-template, html5-template, shokunin, static-site
- Language: HTML
- Homepage: http://kaishi.one/
- Size: 171 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kaishi.one 🌏
Welcome to [Kaishi.one][00], a Starter Template for [Shokunin][01]! This
documentation will guide you through the process of getting up and running with
Kaishi in just a few minutes.
![Banner of the Kaishi Starter Template][banner]
## Installation
To use Kaishi, you'll need to install the Rust-based library called
[Shokunin][01].
Follow the steps below to get started:
1. **Install the Rust toolchain**: Before installing Shokunin and Kaishi, make
sure you have the Rust toolchain installed on your machine. You can find
instructions for installing the Rust toolchain on the [Rust website][02].
2. **Install Shokunin**: Once you have the Rust toolchain installed, open your
terminal and run the following command to install Shokunin:
```shell
cargo install ssg
```
Shokunin is the core library that powers Kaishi. It is a Rust-based static site
generator that can be used to generate a static website from a set of Markdown
files and HTML templates.
3. **Download the Kaishi Starter Template**: You can download the Kaishi Starter
Template from the [Kaishi website](https://kaishi.one). Alternatively, you
can download the Kaishi Starter Template directly from [GitHub][03].
## Usage 📖
Shokunin provides a simple command line interface (CLI) for managing and
building your website. Here are some of the most common commands:
- **Create a new site**: Use the following command to create a new site based on
the Kaishi template:
```shell
cd kaishi/
ssg --new=docs --content=_posts --template=_layouts --output=output --serve=public
```
Alternatively, you can use the shorthand version of the command:
```shell
cd kaishi/
ssg -n=docs -c=_posts -t=_layouts -o=output -s=public
```
This command will create a new directory called `docs` within the Kaishi project
directory. It will use the specified `_posts` directory for your site's content,
the `_layouts` directory for the site's template files, and generate the output
files in the output directory.
Now you're ready to start building your website with Kaishi! Feel free to
customize the content, modify the template, and explore the features of
Shokunin.
Happy coding!
[banner]: https://kura.pro/kaishi/images/titles/title-kaishi.svg "Banner of the Kaishi Starter Template"
[00]: https://kaishi.one/ "Kaishi Starter Template Website"
[01]: https://shokunin.one/ "Shokunin Static Site Generator Website"
[02]: https://www.rust-lang.org/learn/get-started "Rust Programming Language Website"
[03]: https://github.com/sebastienrousseau/kaishi.github.io "Kaishi Starter Template on GitHub"