Crate krik

Crate krik 

Source
Expand description

§Krik - Fast Static Site Generator

Krik is a fast static site generator written in Rust that transforms Markdown files into beautiful, responsive websites with internationalization support and modern theming.

§Features

  • Full Markdown Support: GitHub Flavored Markdown with tables, footnotes, and code blocks
  • Internationalization: Multi-language support with filename-based detection
  • Theme System: Automatic light/dark mode with responsive design
  • Advanced Navigation: Table of contents, footnote links, and scroll-to-top
  • Atom Feeds: RFC 4287 compliant feed generation
  • Fast Performance: Built with Rust for optimal speed

§Quick Start

use krik::generator::SiteGenerator;
use std::path::PathBuf;

// Create a new site generator
let mut generator = SiteGenerator::new(
    PathBuf::from("content"),
    PathBuf::from("_site"),
    None::<PathBuf>
)?;

// Scan for markdown files
generator.scan_files()?;

// Generate the site
generator.generate_site()?;

§Content Organization

  • content/posts/ - Blog posts (uses post template)
  • content/pages/ - Static pages (uses page template)
  • content/site.toml - Site configuration
  • content/images/ - Images and assets (copied as-is)

Re-exports§

pub use error::*;
pub use generator::*;
pub use i18n::*;
pub use logging::*;
pub use parser::*;
pub use site::*;
pub use theme::*;

Modules§

cli
content
error
generator
Site generation functionality for Krik
i18n
init
lint
Content linting and validation module
logging
parser
server
site
theme

Macros§

config_error
Create a context-aware config error
io_error
Create a context-aware I/O error
markdown_error
Create a context-aware markdown error
template_error
Create a context-aware template error