Shevky Documentation

Shevky is a minimal, dependency-light static site generator built with Node.js. It transforms Markdown content with YAML front matter into multi-language HTML pages using Mustache templates, with a hook-based plugin system for extensibility.

This documentation is organized for three audiences:

  • New users - install, first project, first build, and deploy.
  • Intermediate users - configuration, CLI workflows, troubleshooting, and customization.
  • Advanced users - architecture internals, plugin system, and extension authoring.

Recommended Reading Order

  1. Getting Started - prerequisites, installation, quickstart
  2. Tutorials - step-by-step from first project to deployment
  3. Guides - configuration, CLI usage, troubleshooting
  4. Deploy - production builds and hosting options
  5. Extend - plugin system, authoring, and first-party plugin catalog
  6. Reference - configuration keys, CLI flags, types, glossary

Sections

SectionDescription
Getting StartedFrom zero to a running site
TutorialsHands-on step-by-step path
GuidesTask-oriented how-to guides
DeployBuild artifacts and hosting
ExtendPlugin system and authoring
ReferenceTechnical reference material
LicenseLicense terms and memorial note