Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 1.59 KB

README.md

File metadata and controls

50 lines (35 loc) · 1.59 KB

Capydocs 11ty Template

A minimal documentation starter built with Eleventy. It ships with sensible defaults for Capybara Labs' Capydocs theme, including a docs landing page, blog posts, and reusable includes for navigation and layout blocks.

Getting started

pnpm install

Local development

pnpm dev

This runs Eleventy's dev server with hot reloading. Visit the printed URL (usually http://localhost:8080).

Production build

pnpm build

This outputs the generated site to _site/. Use pnpm preview to serve the production build locally.

Cleaning build artifacts

pnpm clean

Removes the _site/ directory.

Project structure

Path Description
index.md Home page content.
_posts/ Markdown blog posts (processed via Eleventy's collections).
_includes/ Layouts, partials, and shortcodes shared across pages.
.eleventy.js Eleventy configuration (collections, filters, passthrough copy).

Customization tips

  • Update metadata (title, description, navigation) inside .eleventy.js or the corresponding includes.
  • Add additional Markdown pages anywhere in the root; Eleventy automatically builds them.
  • Use Markdown-It plugins inside .eleventy.js to extend Markdown syntax.
  • Leverage Luxon utilities for date formatting in templates.

Deploying

Any static hosting provider works (Netlify, Vercel, GitHub Pages). Point the host to deploy the _site/ directory produced by pnpm build.