Templates Command
Manage README templates
Syntax
qmims templates <action> [name] [path] [options]
Actions
| Action | Description |
|---|---|
| list | List all available templates |
| show | Show the content of a specific template |
| add | Add a custom template |
| remove | Remove a custom template |
Options
| Option | Alias | Description |
|---|---|---|
| --verbose | -V | Show detailed output for debugging |
Examples
List all templates:
qmims templates list
Show a specific template:
qmims templates show basic
Add a custom template:
qmims templates add my-template path/to/template.md
Remove a custom template:
qmims templates remove my-template
Built-in Templates
qmims includes five built-in templates:
| Template | Description |
|---|---|
| basic | Simple README with essential sections |
| detailed | Comprehensive README with extended sections |
| minimal | Minimal project overview |
| library | Focused on API documentation |
| service | Tailored for web services/APIs |
Creating Custom Templates
You can create your own custom templates to match your project's specific needs. Templates are Markdown files with special comments that serve as placeholders for generated content.
# {{projectName}}
<!-- qmims:generate: Write a concise description of the project based on its structure and purpose -->
## Installation
<!-- qmims:generate: Provide installation instructions based on the detected package manager -->
## Usage
<!-- qmims:generate: Create usage examples based on the project's main functionality -->Tip
When creating custom templates, you can use the
{{\"projectName\"}} placeholder to automatically insert the project name based on the directory or package.json.For more information on working with templates, see the Working with Templates section.