Skip to content

Latest commit

 

History

History
85 lines (69 loc) · 2.8 KB

README.md

File metadata and controls

85 lines (69 loc) · 2.8 KB
Raw

npx degit TheOtterlord/manual



Manual

🚀 Getting Started

Once you've downloaded the template with npx degit TheOtterlord/manual, install dependencies and start the dev server:

npm install
npm run dev

📚 Features

  • 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)

📁 Project Structure

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.

📝 License

Manual is licensed under the MIT License.