Welcome to Kaishi.one, a Starter Template for Shokunin! This documentation will guide you through the process of getting up and running with Kaishi in just a few minutes.
To use Kaishi, you'll need to install the Rust-based library called Shokunin.
Follow the steps below to get started:
-
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.
-
Install Shokunin: Once you have the Rust toolchain installed, open your terminal and run the following command to install Shokunin:
cargo install ssgShokunin 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.
- Download the Kaishi Starter Template: You can download the Kaishi Starter Template from the Kaishi website. Alternatively, you can download the Kaishi Starter Template directly from GitHub.
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:
cd kaishi/
ssg --new=docs --content=_posts --template=_layouts --output=output --serve=publicAlternatively, you can use the shorthand version of the command:
cd kaishi/
ssg -n=docs -c=_posts -t=_layouts -o=output -s=publicThis 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!