Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/masterkram/minted-directory
Markdown driven directory template. Built with Nuxt, Nuxt Content and Tailwindcss. Optimized for SEO. Beautiful Customizable Style
https://github.com/masterkram/minted-directory
nuxt nuxt-content nuxt-seo nuxt-template tailwindcss
Last synced: about 1 month ago
JSON representation
Markdown driven directory template. Built with Nuxt, Nuxt Content and Tailwindcss. Optimized for SEO. Beautiful Customizable Style
- Host: GitHub
- URL: https://github.com/masterkram/minted-directory
- Owner: masterkram
- License: mit
- Created: 2024-06-14T13:41:50.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T15:08:46.000Z (2 months ago)
- Last Synced: 2024-10-25T11:45:51.975Z (2 months ago)
- Topics: nuxt, nuxt-content, nuxt-seo, nuxt-template, tailwindcss
- Language: Vue
- Homepage: https://minteddirectory.com
- Size: 19 MB
- Stars: 22
- Watchers: 1
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Minted Directory Template
Markdown driven directory template. Built with Nuxt, Nuxt Content and Tailwindcss. Optimized for SEO. Beautiful Customizable Style
Learn more at [minteddirectory.com](https://minteddirectory.com)
Read the [docs](https://minteddirectory.com/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.
```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 --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 `app.config.ts`
Read about the possible changes to the app config [here](https://minteddirectory/docs/settings).
### 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:
```bash
pnpm run generate
```
Check out the [deployment documentation](https://minteddirectory.com/docs/deployment) for more information.
---