Shokunin Quick Start Guide: Get up and running quickly
Leverage the simplicity and power of Shokunin, a cutting-edge Static Site Generator (SSG) created for speed and flexibility.
4 easy steps to build a website with Shokunin
Let’s learn how to build a website with the Shokunin Static Site Generator (SSG) in 4 easy steps:
1. Download the Kaishi starter template
2. Unzip the package
Unzip the package and rename the
kaishi folder to your project name.
mv kaishi mysite
Understanding the Kaishi folder directory
The Kaishi Starter Template is organised in a way that allows for simple content management and website organisation. It has the following folders and files inside:
│ ├── 404.md
│ ├── contact.md
│ ├── features.md
│ ├── index.md
│ ├── offline.md
│ ├── privacy.md
│ └── terms.md
3 directories, 13 files
The content and presentation are separate, so you can change the site’s look and
feel without changing its content. The
content directory stores Markdown files,
should be used as a starting point for your website and can be modified to suit
Change to the project directory
3. Generate the new site
ssg -n=docs -c=content -t=template -o=output -s=public
ssg command will generate a new site in the
docs directory using the
content from the
content directory and the template from the
directory. The generated site will be stored in the
docs directory. The
public and the
output directories are used during the build process and can
be safely ignored. The
ssg command will also start a local web server on port
8000 to serve the generated site.
You can now look at the generated site by opening the following url in your browser:
4. Deploy the site (optional)
You can deploy the site to your server by copying the
docs directory to your
server. You can also use a CI/CD pipeline to automate the deployment process.
For example, you can use GitHub Pages ⧉ to host your site for free.
Congratulations! You have successfully created your first website with Shokunin. If you would like to contribute to Shokunin, please check out our instructions on how to contribute.