Once you've downloaded the template with npx degit TheOtterlord/manual
, install dependencies and start the dev server:
npm install
npm run dev
- Astro - Blazingly fast static site generation & type-safe frontmatter
- Tailwind CSS - Quick & efficient styling
- Pagefind - Powering static search
- RSS - Syndication feed
- OpenGraph - Social media previews (including procedurally generated images)
Inside your project, you'll see the following useful folders and files:
/
โโโ public/
โ โโโ favicon.svg
โโโ src/
โ โโโ components/
โ โ โโโ Navigation.astro
โ โโโ content/
โ โ โโโ blog/
โ โ โโโ docs/
โ | โโโ config.ts
โ โโโ layouts/
โ โ โโโ Base.astro
โ โ โโโ Blog.astro
โ โ โโโ Docs.astro
โ โโโ lib/
โ โโโ pages/
โ โ โโโ blog/
โ โ | โโโ [id].astro
โ โ | โโโ index.astro
โ โ โโโ docs/
โ โ | โโโ [...id].astro
โ โ โโโ images/
โ โ | โโโ [...id].png.ts
โ โ โโโ 404.astro
โ โ โโโ index.astro
โ โ โโโ rss.xml.ts
โ โโโ site_config.ts
โโโ astro.config.mjs
โโโ package.json
โโโ tailwind.config.js
Content is stored in the src/content
folder. This is where you'll find your blog posts (blogs/
), documentation (docs/
), and configuration (config.ts
). The config.ts
file is where the frontmatter type definitions are made.
OpenGraph images are procedurally generated from the src/pages/images
folder. You can change the default image by editing the HTML defined in src/pages/images/[...id].png.ts
.
Manual is licensed under the MIT License.