S.H.E.V.K.Y. documentation

Publish the site you want fast with S.H.E.V.K.Y.!

Ship all your static sites with S.H.E.V.K.Y. Publish quickly with Markdown content, flexible templates, and a simple setup.

Publish your first page in 5 minutes.

S.H.E.V.K.Y. mascot

Quick summary

Simple setup

Build with one command and ship the static output anywhere.

Content-first

Write in Markdown, structure with Mustache, and output HTML.

Great for small teams

Move fast with a clear structure and shared conventions.

A clear picture of building with S.H.E.V.K.Y.

Use it for personal sites, documentation, blogs, and any static content.

Can I build both a landing page and a documentation site in one project?

Yes. Shevky can manage landing pages, docs, blogs, and other static page types in a single project. Content is stored with Markdown + front matter, then rendered into one `dist/` output using template/layout selection.

How quickly can I ship a first version?

With the quickstart flow, you can ship a working baseline in a few steps: install dependencies, create your first Markdown page, run `shevky --build`, and deploy the static output.

How does multilingual support work?

You define language configuration with `content.languages` in `site.json`. Each content file declares `lang`; Shevky then generates per-language URLs, menus, canonical/alternate metadata, and feed/sitemap outputs.

What can I customize with the plugin system?

Plugins let you extend build hooks for asset processing (Tailwind/esbuild), SEO/OG metadata, RSS, sitemap, robots.txt, and external content ingestion.

Do I need a backend or runtime server?

No. Shevky generates plain static files at build time. Output lives in `dist/` and can be served directly on any static hosting platform.

Where can I deploy the output?

You can deploy to GitHub Pages, Netlify, Vercel, Docker, or any platform that serves static files. CI/CD pipelines can also automate build and release flows.

Quick start

Install, run, and publish your first page. The essentials from setup to first build are here.

  • Set up the project scaffold and install the required packages.
  • Write your first Markdown page and fill the frontmatter.
  • Build, preview locally, and publish the static output.
S.H.E.V.K.Y. process flow

S.H.E.V.K.Y. Documentation

Track installation, structure, theming, and deployment in one place.