Learn more at minteddirectory.com

Read the docs

Features:

• 🖌️ Add Listings with markdown.
• 🔋 Batteries included for SEO (nuxt seo module).
• 💻 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 git@github.com: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 --private --clone

Go to the cloned folder:

cd my-directory

Install dependencies

pnpm install

Run the website:

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 app.config.ts

Read about the possible changes to the app config here.

Adding Content

Add listings by adding markdown files to /content/dir

Add blog articles by adding markdown files to /content/blog

Deployment

Deploy as a pre-rendered, static site for best SEO performance:

pnpm run generate

Check out the deployment documentation for more information.

---