Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/masterkram/minted-directory-astro
Markdown driven directory template. Built with Astro and Tailwindcss. Optimized for SEO. Beautiful Customizable Style
https://github.com/masterkram/minted-directory-astro
astro directory
Last synced: 23 days ago
JSON representation
Markdown driven directory template. Built with Astro and Tailwindcss. Optimized for SEO. Beautiful Customizable Style
- Host: GitHub
- URL: https://github.com/masterkram/minted-directory-astro
- Owner: masterkram
- Created: 2024-10-15T21:09:01.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-16T16:52:31.000Z (3 months ago)
- Last Synced: 2024-10-19T09:02:42.585Z (3 months ago)
- Topics: astro, directory
- Language: Astro
- Homepage: https://minteddirectory.com
- Size: 15.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Minted Directory Astro
Markdown driven directory template. Built with Astro and Tailwindcss. Optimized for SEO. Beautiful Customizable Style
## Features:
+ 🖌️ Add Listings with markdown.
+ 🔋 SEO optimizations and pSEO out of the box
+ 💻 Pre-built components for directories.
+ 💅 Customizable style.
+ 🌙 Dark/Light mode
+ 💸 Sponsored Content## Getting Started
### Local Development
Duplicate the template then clone the repository.
```sh
git clone [email protected]:youraccount/projectname.git my-directory
```Or use the github cli to create a repository based on the template and clone in one command:
```sh
gh repo create my-directory --template masterkram/minted-directory-astro --private --clone
```Go to the cloned folder:
```sh
cd my-directory
```Install dependencies
```sh
pnpm install
```Run the website:
```sh
pnpm dev
```Congrats :tada:
You can start customizing and building your directory.
## Customization
To customize the directory style:
+ Change the `primary`, `secondary` color and `fontFamily` in `tailwind.config.ts`
+ Customize the `src/config/theme-config.toml`### Adding Content
Add listings by adding markdown files to `/src/content/directory`
## Deployment
Deploy as a static site for best SEO performance:
```bash
pnpm run build
```