Skip to content

Commit

Permalink
Merge pull request #115 from sebastienrousseau/feat/ssg
Browse files Browse the repository at this point in the history
feat(ssg): v0.0.18
  • Loading branch information
sebastienrousseau authored Sep 27, 2023
2 parents cf0c983 + 3b59df9 commit 5ded5d0
Show file tree
Hide file tree
Showing 38 changed files with 1,021 additions and 416 deletions.
75 changes: 22 additions & 53 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ name = "ssg"
readme = "README.md"
repository = "https://github.com/sebastienrousseau/shokunin"
rust-version = "1.71.1"
version = "0.0.17"
version = "0.0.18"
include = [
"/CONTRIBUTING.md",
"/LICENSE-APACHE",
Expand All @@ -46,7 +46,7 @@ harness = false
path = "benches/bench.rs"

[dependencies]
clap = "4.4.2"
clap = "4.4.5"
comrak = "0.18.0"
dtt = "0.0.4"
log = {version="0.4.20", features = ["std"] }
Expand All @@ -56,10 +56,10 @@ quick-xml = "0.30.0"
regex = "1.9.5"
reqwest = { version = "0.11.20", features = ["blocking", "json"] }
serde = { version = "1.0.188", features = ["derive"] }
serde_json = "1.0.106"
serde_json = "1.0.107"
serde_yaml = "0.9.25"
tempfile = "3.8.0"
toml = "0.7.8"
toml = "0.8.1"
yaml-rust = "0.4.5"
vrd = "0.0.4"

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ To use the Shokunin Static Site Generator (SSG) library in your project, add the

```toml
[dependencies]
shokunin = "0.0.17"
shokunin = "0.0.18"
```

Add the following to your `main.rs` file:
Expand Down Expand Up @@ -282,6 +282,6 @@ A special thank you goes to the [Rust Reddit][13] community for providing a lot
[crates-badge]: https://img.shields.io/crates/v/ssg.svg?style=for-the-badge 'Crates.io badge'
[divider]: https://kura.pro/common/images/elements/divider.svg "divider"
[docs-badge]: https://img.shields.io/docsrs/ssg.svg?style=for-the-badge 'Docs.rs badge'
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.17-orange.svg?style=for-the-badge 'Lib.rs badge'
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.18-orange.svg?style=for-the-badge 'Lib.rs badge'
[license-badge]: https://img.shields.io/crates/l/ssg.svg?style=for-the-badge 'License badge'
[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust badge'
4 changes: 2 additions & 2 deletions TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<!-- markdownlint-enable MD033 MD041 -->

# Shokunin Static Site Generator v0.0.17 🦀
# Shokunin Static Site Generator v0.0.18 🦀

A Content-First Open Source Static Site Generator (SSG) written in Rust

Expand Down Expand Up @@ -70,7 +70,7 @@ Shokunin Static Site Generator (SSG) feature highlights include:
[crates-badge]: https://img.shields.io/crates/v/ssg.svg?style=for-the-badge 'Crates.io badge'
[divider]: https://kura.pro/common/images/elements/divider.svg "divider"
[docs-badge]: https://img.shields.io/docsrs/ssg.svg?style=for-the-badge 'Docs.rs badge'
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.17-orange.svg?style=for-the-badge 'Lib.rs badge'
[libs-badge]: https://img.shields.io/badge/lib.rs-v0.0.18-orange.svg?style=for-the-badge 'Lib.rs badge'
[license-badge]: https://img.shields.io/crates/l/ssg.svg?style=for-the-badge 'License badge'
[made-with-rust-badge]: https://img.shields.io/badge/rust-f04041?style=for-the-badge&labelColor=c0282d&logo=rust 'Made With Rust badge'

Expand Down
3 changes: 2 additions & 1 deletion content/404.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ banner_height: "398"
banner_width: "1440"
banner: "https://kura.pro/unsplash/images/banners/ash-from-modern-afflatus-NQ6Lh81BTRs-unsplash.jpg"
cdn: "https://kura.pro"
changefreq: "weekly"
charset: "utf-8"
cname: "kaishi.one"
copyright: "© 2023 Kaishi. All rights reserved."
Expand Down Expand Up @@ -38,7 +39,7 @@ revisit-after: "7 days"
robots: "index, follow"
short_name: "404"
subtitle: "Sorry we can't find that page."
theme_color: "rgb(143, 250, 111)"
theme-color: "rgb(143, 250, 111)"
tags: "404, page not found, not available"
title: "404"
url: "https://kaishi.one/404/"
Expand Down
3 changes: 2 additions & 1 deletion content/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ banner_height: "398" ## The banner height of the site.
banner_width: "1440" ## The banner width of the site.
banner: "https://kura.pro/unsplash/images/banners/vishal-bansal-SC5sXeyjloE-unsplash.jpg" ## The banner of the site.
cdn: "https://kura.pro" ## The CDN of the site.
changefreq: "weekly" ## The changefreq of the site.
charset: "utf-8" ## The charset of the site. (default: utf-8)
cname: "kaishi.one" ## The cname value of the site. (Only required for the index page.)
copyright: "© 2023 Kaishi. All rights reserved." ## The copyright of the site.
Expand Down Expand Up @@ -40,7 +41,7 @@ robots: "index, follow" ## The robots of the site.
short_name: "kaishi" ## The short name of the site. (max 12 characters)
subtitle: "How can we help you today?" ## The subtitle of the page. (max 64 characters)
tags: "contact us, contact form, get in touch, contact page, contact information, customer service, support, feedback, questions, inquiries, help" ## The tags of the site. (max 160 characters)
theme_color: "rgb(143, 250, 111)" ## The theme color of the site.
theme-color: "rgb(143, 250, 111)" ## The theme color of the site.
title: "Contact Us" ## The title of the page. (max 64 characters)
url: "https://kaishi.one" ## The url of the site.
viewport: "width=device-width, initial-scale=1, shrink-to-fit=no" ## The viewport of the site.
Expand Down
30 changes: 28 additions & 2 deletions content/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ banner_height: "398" ## The banner height of the site.
banner_width: "1440" ## The banner width of the site.
banner: "https://kura.pro/unsplash/images/banners/ryunosuke-kikuno-G5hYMUoJQf8-unsplash.jpg" ## The banner of the site.
cdn: "https://kura.pro" ## The CDN of the site.
changefreq: "weekly" ## The changefreq of the site.
charset: "utf-8" ## The charset of the site. (default: utf-8)
cname: "kaishi.one" ## The cname value of the site. (Only required for the index page.)
copyright: "© 2023 Kaishi. All rights reserved." ## The copyright of the site.
Expand All @@ -24,7 +25,7 @@ image_width: "1200" ## The image width of the site.
image: "https://kura.pro/kaishi/images/banners/banner-kaishi.webp" ## The main image of the site in SVG format.
keywords: "kaishi starter templates, shokunin static site generator, static site generator, starter templates, bootstrap, bootstrap css, bootstrap javascript, content security policy, open graph meta tags, responsive navigation bar, schema.org meta tags" ## The keywords of the site. (max 160 characters)
language: "en-GB" ## The language of the site. (default: en-GB)
layout: "page" ## The layout of the site.
layout: "post" ## The layout of the site.
locale: "en_GB" ## The locale of the site.
logo_alt: "Logo of Kaishi, a starter template for static sites" ## The logo alt of the site.
logo_height: "33" ## The logo height of the site.
Expand All @@ -39,7 +40,7 @@ robots: "index, follow" ## The robots of the site.
short_name: "kaishi" ## The short name of the site. (max 12 characters)
subtitle: "Build Amazing Websites with Minimal Effort using Kaishi Starter Templates" ## The subtitle of the page. (max 64 characters)
tags: "kaishi starter templates, shokunin static site generator, static site generator, starter templates, bootstrap, bootstrap css, bootstrap javascript, content security policy, open graph meta tags, responsive navigation bar, schema.org meta tags" ## The tags of the site. (max 160 characters)
theme_color: "rgb(143, 250, 111)" ## The theme color of the site.
theme-color: "rgb(143, 250, 111)" ## The theme color of the site.
title: "Features" ## The title of the page. (max 64 characters)
url: "https://kaishi.one" ## The url of the site.
viewport: "width=device-width, initial-scale=1, shrink-to-fit=no" ## The viewport of the site.
Expand Down Expand Up @@ -105,6 +106,7 @@ site_software: "Shokunin, Rust" ## The software of the site.

---


## Starter Templates

All the starter templates, whether pages or websites are built from scratch
Expand All @@ -116,13 +118,37 @@ your website or web application.

**Kaishi Starter Templates** has the following features enabled:

<!-- markdownlint-disable MD033 -->
<div class="row g-4 py-5 row-cols-1 row-cols-lg-2">
<div class="p-3">
<div class="card bg-light text-dark p-5 h-100">
<div class="card-body">
<!-- markdownlint-restore -->

- **Accessibility Meta-Tags:** These meta tags are designed to make the website more accessible to users with disabilities. By setting Accessible Rich Internet Applications (ARIA) roles and attributes, full keyboard control, and no flashing hazard, you can make sure your website is accessible to everyone.
- **Apple Meta-Tags:** These meta tags improve websites for Apple devices, like iPhones, iPads, and Apple devices. You can change web app capabilities, status bar style, title, application name, and author to improve Apple devices' appearance.
- **Bootstrap CSS:** Bootstrap is a popular CSS framework that provides you with a set of pre-designed styles and components. By using Bootstrap, you can quickly and easily create a professional-looking website without having to write CSS from scratch.
- **Bootstrap JavaScript:** Bootstrap JavaScript is a set of pre-built scripts that provide you with responsive navigation menus and modal dialogues.
<!-- markdownlint-disable MD033 -->
</div>
</div>
</div>

<div class="p-3">
<div class="card bg-dark text-light p-5 h-100">
<div class="card-body">
<!-- markdownlint-disable restore -->

- **Content Security Policy:** This meta tag is used to specify the sources of content allowed to load on the page. It is designed to prevent cross-site scripting (XSS) attacks and other security vulnerabilities.
- **Microsoft Meta Tags:** These meta tags are designed to optimise the website for Microsoft devices. You can set site verification, application configuration, tap highlight colour, tile colour, and tile image to look good on Windows devices.
- **Open Graph/Facebook Meta-Tags:** These meta tags allow you to control how your website appears when shared on Facebook and other social media platforms. By setting the title, description, and image, you can make sure that your website looks its best when shared online.
- **Responsive Navigation Bar:** The responsive navigation bar provides users with an intuitive and easy-to-use interface for navigating the website. It aims to adapt to the size of the screen, making it accessible to users on both desktop and mobile devices.
- **Schema.org Meta Tags:** These meta tags are used to provide structured data about the website's content. Setting the name, description, and image on a website helps search engines and others understand the content better.
- **Twitter Meta Tags:** These meta tags are designed to optimise the website for Twitter sharing. You can set the card type, creator, description, image, site, title, and URL to make their website look good on Twitter.

<!-- markdownlint-disable MD033 -->
</div>
</div>
</div>
</div>
<!-- markdownlint-disable restore -->
3 changes: 2 additions & 1 deletion content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ banner_height: "398" ## The banner height of the site.
banner_width: "1440" ## The banner width of the site.
banner: "https://kura.pro/unsplash/images/banners/bernardo-lorena-ponte-cEp2Tow6XKk-unsplash.jpg" ## The banner of the site.
cdn: "https://kura.pro" ## The CDN of the site.
changefreq: "weekly" ## The changefreq of the site.
charset: "utf-8" ## The charset of the site. (default: utf-8)
cname: "kaishi.one" ## The cname value of the site. (Only required for the index page.)
copyright: "© 2023 Kaishi. All rights reserved." ## The copyright of the site.
Expand Down Expand Up @@ -38,7 +39,7 @@ revisit-after: "7 days" ## The revisit after of the site.
robots: "index, follow" ## The robots of the site.
short_name: "kaishi" ## The short name of the site. (max 12 characters)
subtitle: "Build Amazing Websites with Minimal Effort using Kaishi Starter Templates" ## The subtitle of the page. (max 64 characters)
theme_color: "rgb(143, 250, 111)" ## The theme color of the site.
theme-color: "rgb(143, 250, 111)" ## The theme color of the site.
tags: "kaishi, shokunin static site generator, static site generator, minimalist website template, modern website template, responsive website template, website starter template, freelance creative, startup founder, small business owner, online presence" ## The tags of the site. (comma separated, max 10 tags)
title: "Kaishi, a Shokunin Static Site Generator Starter Template" ## The title of the page. (max 64 characters)
url: "https://kaishi.one" ## The url of the site.
Expand Down
Loading

0 comments on commit 5ded5d0

Please sign in to comment.