Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TheOtterlord/manual
A feature full Astro documentation template
https://github.com/TheOtterlord/manual
astro documentation pagefind template withastro
Last synced: 3 months ago
JSON representation
A feature full Astro documentation template
- Host: GitHub
- URL: https://github.com/TheOtterlord/manual
- Owner: TheOtterlord
- License: mit
- Created: 2023-02-25T13:49:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-02T15:40:59.000Z (about 1 year ago)
- Last Synced: 2024-06-08T19:34:58.972Z (5 months ago)
- Topics: astro, documentation, pagefind, template, withastro
- Language: Astro
- Homepage: https://manual.otterlord.dev
- Size: 987 KB
- Stars: 37
- Watchers: 1
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
npx degit TheOtterlord/manual
> This repo is no longer actively maintained
## 🚀 Getting Started
Once you've downloaded the template with `npx degit TheOtterlord/manual`, install dependencies and start the dev server:
```bash
npm install
npm run dev
```
## 📚 Features
- [Astro](https://astro.build) - Blazingly fast static site generation & type-safe frontmatter
- [Tailwind CSS](https://tailwindcss.com) - Quick & efficient styling
- [Pagefind](https://pagefind.app) - Powering static search
- [RSS](https://en.wikipedia.org/wiki/RSS) - Syndication feed
- [OpenGraph](https://ogp.me) - 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](LICENSE).