1. Project Overview & Quickstart (dreammis/LICENSE)
LICENSE
Open-source repository dreammis/LICENSE
Repository Details
- Repository: dreammis/LICENSE
- Primary Language: Code
Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.
2. Official Technical Reference & Guides (dreammis/docs)
File: README.md
Mintlify Starter Kit
Use the starter kit to get your docs deployed and ready to customize.
Click the green Use this template button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with
- Guide pages
- Navigation
- Customizations
- API reference pages
- Use of popular components
Follow the full quickstart guide
AI-assisted writing
Set up your AI coding tool to work with Mintlify:
npx skills add https://mintlify.com/docsThis command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.
See the AI tools guides for tool-specific setup.
Development
Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:
npm i -g mintRun the following command at the root of your documentation, where your docs.json is located:
mint devView your local preview at http://localhost:3000.
Publishing changes
Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.
Need help?
Troubleshooting
- If your dev environment isn't running: Run
mint updateto ensure you have the most recent version of the CLI. - If a page loads as a 404: Make sure you are running in a folder with a valid
docs.json.
Resources
File: AGENTS.md
First-time setup: Customize this file for your project. Prompt the user to customize this file for their project.
For Mintlify product knowledge (components, configuration, writing standards),
install the Mintlify skill:npx skills add https://mintlify.com/docs
Documentation project instructions
About this project
- This is a documentation site built on Mintlify
- Pages are MDX files with YAML frontmatter
- Configuration lives in
docs.json - Use the Mintlify MCP server,
https://mcp.mintlify.com, to edit content and settings via MCP - Use the Mintlify docs MCP server,
https://www.mintlify.com/docs/mcp, to query information about using Mintlify via MCP
Terminology
{/* Add product-specific terms and preferred usage /}
{/ Example: Use "workspace" not "project", "member" not "user" */}
Style preferences
{/* Add any project-specific style rules below */}
- Use active voice and second person ("you")
- Keep sentences concise โ one idea per sentence
- Use sentence case for headings
- Bold for UI elements: Click Settings
- Code formatting for file names, commands, paths, and code references
Content boundaries
{/* Define what should and shouldn't be documented /}
{/ Example: Don't document internal admin features */}
File: docs.json
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Mintlify Starter Kit",
"colors": {
"primary": "#16A34A",
"light": "#07C983",
"dark": "#15803D"
},
"favicon": "/favicon.svg",
"navigation": {
"pages": [
{
"group": "Getting Started",
"pages": [
"index",
"quickstart"
]
}
],
"global": {
"anchors": [
{
"anchor": "Documentation",
"href": "https://mintlify.com/docs",
"icon": "book-open-cover"
},
{
"anchor": "Blog",
"href": "https://mintlify.com/blog",
"icon": "newspaper"
}
]
}
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"navbar": {
"links": [
{
"label": "Support",
"href": "mailto:[email protected]"
}
],
"primary": {
"type": "button",
"label": "Dashboard",
"href": "https://app.mintlify.com"
}
},
"contextual": {
"options": [
"copy",
"view",
"chatgpt",
"claude",
"perplexity",
"mcp",
"cursor",
"vscode"
]
},
"footer": {
"socials": {
"x": "https://x.com/mintlify",
"github": "https://github.com/mintlify",
"linkedin": "https://linkedin.com/company/mintlify"
}
}
}
File: index.mdx
title: "Introduction"
Write a short description of your product here. What it does, who it's for, and what they can accomplish with it.
File: quickstart.mdx
title: "Quickstart"
Describe how someone begins using your product. What is the first thing they need to do? Are there any prerequisites?
A quickstart should take someone from zero to using your product. They'll get a quick win and a sense of what they can accomplish.
Prerequisites
Before you begin, you must have:
- Requirement one (for example, Node.js 18+, a free account, an API key)
- Requirement two (for example, a compatible device, a compatible browser, a compatible operating system)
Get started
```bash
npm install your-package
``````bash
your-cli init
``````bash
your-cli start
``` Example: Need help? Reach out to us at [email protected].