README.md

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.

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:

gh repo create my-directory --template masterkram/minted-directory-astro --private --clone

Go to the cloned folder:

cd my-directory

Install dependencies

pnpm install

Run the website:

pnpm dev

Congrats 🎉

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:

pnpm run build