+ by + + {{author}} + +
+ + +All the starter templates, whether pages or websites are built from scratch +using the same principles and features. This means that you can easily mix and +match them together to create your own custom layouts and content. + +Get started with Shokunin using any of our Starter Templates for building +your website or web application. diff --git a/content/privacy.md b/content/privacy.md index cf7a769c..56ca4c04 100644 --- a/content/privacy.md +++ b/content/privacy.md @@ -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/johannes-plenio-6XUA5KQ9-1k-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. @@ -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: "privacy policy, kaishi, shokunin static site generator, static site generator, user data, google analytics, microsoft clarity, tracking tools, personal information, rights, changes" ## 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: "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. viewport: "width=device-width, initial-scale=1, shrink-to-fit=no" ## The viewport of the site. diff --git a/content/tags.md b/content/tags.md index 8d98eab8..04f40ea8 100644 --- a/content/tags.md +++ b/content/tags.md @@ -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/sean-stratton-ObpCE_X3j6U-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. @@ -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: "terms of use, kaishi, shokunin static site generator, static site generator, intellectual property, linked sites, liability, privacy, governing law, changes, contact us" ## 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: "Explore by tag" ## 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. diff --git a/content/terms.md b/content/terms.md index ea30ce25..33655338 100644 --- a/content/terms.md +++ b/content/terms.md @@ -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/sean-stratton-ObpCE_X3j6U-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. @@ -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: "terms of use, kaishi, shokunin static site generator, static site generator, intellectual property, linked sites, liability, privacy, governing law, changes, contact us" ## 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: "Terms of Use" ## 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. diff --git a/src/compiler.rs b/src/compiler.rs index a87d87d2..22517f3e 100644 --- a/src/compiler.rs +++ b/src/compiler.rs @@ -21,7 +21,7 @@ use crate::{ utilities::{ file::add, template::{render_page, PageOptions}, - write::write_files + write::write_files_to_build_directory }, }; use std::{error::Error, fs, path::Path, collections::HashMap}; @@ -286,7 +286,7 @@ pub fn compile( // Iterate over compiled files and write pages to output directory for file in &compiled_files { - write_files(build_dir_path, file, template_path)?; + write_files_to_build_directory(build_dir_path, file, template_path)?; } let tags_html_content = generate_tags_html(&global_tags_data); diff --git a/src/lib.rs b/src/lib.rs index 20c6a60e..cf159fd2 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -10,7 +10,7 @@ //! *Part of the [Mini Functions][0] family of Rust libraries.* //! //! [](https://crates.io/crates/ssg "Crates.io") -//! [](https://lib.rs/crates/ssg "Lib.rs") +//! [](https://lib.rs/crates/ssg "Lib.rs") //! [](https://opensource.org/license/apache-2-0/ "MIT or Apache License, Version 2.0") //! [](https://www.rust-lang.org "Rust") //! @@ -66,7 +66,7 @@ //! //! ```toml //! [dependencies] -//! shokunin = "0.0.17" +//! shokunin = "0.0.18" //! ``` //! //! And in your `main.rs`: diff --git a/src/macros.rs b/src/macros.rs index 88680944..5413a030 100644 --- a/src/macros.rs +++ b/src/macros.rs @@ -287,23 +287,51 @@ macro_rules! macro_metadata_option { /// # `macro_render_layout` Macro /// -/// Selects the appropriate template for rendering based on the specified layout, -/// and uses this template to render a context into a string. +/// This macro selects and renders a specified layout with a given context. +/// +/// * `$layout`: The desired layout name (e.g., "contact", "index", "page"). +/// If a template file corresponding to `$layout.html` exists in the template directory, +/// it will be used. Otherwise, the macro falls back to predefined mappings. +/// +/// * `$template_path`: The path to the directory containing the template files. +/// +/// * `$context`: The context to be rendered into the template. +/// +/// ## Behaviour: +/// +/// 1. If a file named `$layout.html` exists in `$template_path`, it will be used as the template. +/// 2. If no such file exists, the macro checks for predefined layout names: +/// * "contact" maps to "contact.html" +/// * "index" maps to "index.html" +/// * "page" maps to "page.html" +/// 3. If `$layout` is unrecognized and doesn't correspond to a file in the template directory, +/// the macro defaults to using "index.html". +/// +/// ## Returns: +/// +/// The macro returns a rendered string using the selected template and provided context. /// #[macro_export] macro_rules! macro_render_layout { ($layout:expr, $template_path:expr, $context:expr) => {{ let layout_str: &str = &$layout; - let template_file = match layout_str { - "contact" => "contact.html", - "index" => "index.html", - "page" => "page.html", - _ => "index.html", + // Check if a file with the name of the layout exists in the template directory + let file_path = Path::new($template_path).join(format!("{}.html", layout_str)); + let template_file = if file_path.exists() { + format!("{}.html", layout_str) + } else { + match layout_str { + "contact" => "contact.html", + "index" => "index.html", + "page" => "page.html", + "post" => "post.html", + _ => "index.html", + }.to_string() }; let template_content = fs::read_to_string( - Path::new($template_path).join(template_file), + Path::new($template_path).join(&template_file), ) .unwrap(); render_template(&template_content, &$context) diff --git a/src/modules/cname.rs b/src/modules/cname.rs index 533c5668..48454d61 100644 --- a/src/modules/cname.rs +++ b/src/modules/cname.rs @@ -1,13 +1,38 @@ // Copyright © 2023 Shokunin Static Site Generator. All rights reserved. // SPDX-License-Identifier: Apache-2.0 OR MIT +// Import the CnameData model from the `crate::models::data` module. use crate::models::data::CnameData; + +// Import the HashMap collection from the `std::collections` module. use std::collections::HashMap; -/// Function to create CnameData +/// Function to create a CnameData object from a HashMap of metadata. +/// +/// The `metadata` HashMap must contain a key named `cname` with the value +/// of the CNAME record. +/// +/// Returns a CnameData object with the CNAME record value. +/// +/// The `cname` value is the canonical name of the domain or subdomain. It is +/// the "true" name of the domain or subdomain, and it is what other DNS +/// records point to. For example, the `cname` value for the `www.example.com` +/// subdomain is typically `example.com`. +/// +/// The `cname` value is used to create aliases for domains and subdomains. +/// This can be useful for a variety of reasons, such as: +/// +/// * To make it easier for users to remember the domain name or subdomain. +/// * To distribute traffic across multiple servers. +/// * To use a domain name or subdomain with a service provider that does not +/// allow you to create your own DNS records. pub fn create_cname_data(metadata: &HashMapThis is a test page
This is a test.
\n"); +/// assert_eq!(html_str, "This is a test page
This is a test.
\n"); /// /// ``` // @@ -126,7 +126,7 @@ fn generate_header(title: &str, id_regex: &Regex) -> String { if title.is_empty() { return String::new(); } - let header_str = format!("