mirror of
https://github.com/amitwh/markdown-converter.git
synced 2026-08-03 02:11:07 +05:30
feat: add document templates library with 10 templates
This commit is contained in:
@@ -0,0 +1,90 @@
|
||||
# API Documentation
|
||||
|
||||
**Base URL:** `https://api.example.com/v1`
|
||||
**Version:** 1.0
|
||||
**Date:** {{DATE}}
|
||||
|
||||
## Authentication
|
||||
|
||||
All requests require an API key in the header:
|
||||
|
||||
```
|
||||
Authorization: Bearer YOUR_API_KEY
|
||||
```
|
||||
|
||||
## Endpoints
|
||||
|
||||
### Get All Resources
|
||||
|
||||
```
|
||||
GET /resources
|
||||
```
|
||||
|
||||
**Query Parameters:**
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| page | integer | No | Page number (default: 1) |
|
||||
| limit | integer | No | Items per page (default: 20) |
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"data": [],
|
||||
"total": 0,
|
||||
"page": 1
|
||||
}
|
||||
```
|
||||
|
||||
### Get Resource by ID
|
||||
|
||||
```
|
||||
GET /resources/:id
|
||||
```
|
||||
|
||||
**Response:**
|
||||
|
||||
```json
|
||||
{
|
||||
"id": "1",
|
||||
"name": "Resource name",
|
||||
"created_at": "2024-01-01T00:00:00Z"
|
||||
}
|
||||
```
|
||||
|
||||
### Create Resource
|
||||
|
||||
```
|
||||
POST /resources
|
||||
```
|
||||
|
||||
**Request Body:**
|
||||
|
||||
```json
|
||||
{
|
||||
"name": "New resource",
|
||||
"description": "Description"
|
||||
}
|
||||
```
|
||||
|
||||
### Update Resource
|
||||
|
||||
```
|
||||
PUT /resources/:id
|
||||
```
|
||||
|
||||
### Delete Resource
|
||||
|
||||
```
|
||||
DELETE /resources/:id
|
||||
```
|
||||
|
||||
## Error Codes
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 404 | Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Blog Post Title
|
||||
date: {{DATE}}
|
||||
author: Your Name
|
||||
tags: []
|
||||
---
|
||||
|
||||
# Blog Post Title
|
||||
|
||||
## Introduction
|
||||
|
||||
Write your introduction here.
|
||||
|
||||
## Main Content
|
||||
|
||||
Your main content goes here.
|
||||
|
||||
## Conclusion
|
||||
|
||||
Wrap up your thoughts.
|
||||
@@ -0,0 +1,20 @@
|
||||
# Changelog
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
- New feature
|
||||
|
||||
### Changed
|
||||
- Updated feature
|
||||
|
||||
### Fixed
|
||||
- Bug fix
|
||||
|
||||
### Removed
|
||||
- Removed feature
|
||||
|
||||
## [1.0.0] - {{DATE}}
|
||||
|
||||
### Added
|
||||
- Initial release
|
||||
@@ -0,0 +1,59 @@
|
||||
# Comparison: [Option A] vs [Option B]
|
||||
|
||||
**Date:** {{DATE}}
|
||||
**Author:** Your Name
|
||||
|
||||
## Overview
|
||||
|
||||
Brief description of what is being compared and why.
|
||||
|
||||
## Feature Comparison
|
||||
|
||||
| Feature | Option A | Option B |
|
||||
|---------|----------|----------|
|
||||
| Feature 1 | Yes | Yes |
|
||||
| Feature 2 | Yes | No |
|
||||
| Feature 3 | No | Yes |
|
||||
| Feature 4 | Partial | Yes |
|
||||
|
||||
## Pricing
|
||||
|
||||
| Plan | Option A | Option B |
|
||||
|------|----------|----------|
|
||||
| Free | Limited | Limited |
|
||||
| Pro | $10/mo | $15/mo |
|
||||
| Enterprise | Custom | Custom |
|
||||
|
||||
## Pros and Cons
|
||||
|
||||
### Option A
|
||||
|
||||
**Pros:**
|
||||
- Pro 1
|
||||
- Pro 2
|
||||
|
||||
**Cons:**
|
||||
- Con 1
|
||||
- Con 2
|
||||
|
||||
### Option B
|
||||
|
||||
**Pros:**
|
||||
- Pro 1
|
||||
- Pro 2
|
||||
|
||||
**Cons:**
|
||||
- Con 1
|
||||
- Con 2
|
||||
|
||||
## Performance
|
||||
|
||||
| Metric | Option A | Option B |
|
||||
|--------|----------|----------|
|
||||
| Speed | Fast | Moderate |
|
||||
| Memory | Low | Medium |
|
||||
| Scalability | Good | Excellent |
|
||||
|
||||
## Recommendation
|
||||
|
||||
Based on the analysis above, [Option A/B] is recommended for [use case] because [reason].
|
||||
@@ -0,0 +1,26 @@
|
||||
# Meeting Notes
|
||||
|
||||
**Date:** {{DATE}}
|
||||
**Attendees:**
|
||||
- Name 1
|
||||
- Name 2
|
||||
|
||||
## Agenda
|
||||
|
||||
1. Topic 1
|
||||
2. Topic 2
|
||||
|
||||
## Discussion
|
||||
|
||||
### Topic 1
|
||||
|
||||
Notes here.
|
||||
|
||||
## Action Items
|
||||
|
||||
- [ ] Action item 1 — Owner — Due date
|
||||
- [ ] Action item 2 — Owner — Due date
|
||||
|
||||
## Next Meeting
|
||||
|
||||
Date: TBD
|
||||
@@ -0,0 +1,54 @@
|
||||
# Project Plan: [Project Name]
|
||||
|
||||
**Date:** {{DATE}}
|
||||
**Project Lead:** Your Name
|
||||
**Status:** Planning
|
||||
|
||||
## Goals
|
||||
|
||||
1. Primary goal
|
||||
2. Secondary goal
|
||||
|
||||
## Scope
|
||||
|
||||
### In Scope
|
||||
- Item 1
|
||||
- Item 2
|
||||
|
||||
### Out of Scope
|
||||
- Item 1
|
||||
|
||||
## Milestones
|
||||
|
||||
| Milestone | Target Date | Status |
|
||||
|-----------|-------------|--------|
|
||||
| Kickoff | {{DATE}} | Not Started |
|
||||
| MVP | TBD | Not Started |
|
||||
| Launch | TBD | Not Started |
|
||||
|
||||
## Resources
|
||||
|
||||
| Role | Person | Allocation |
|
||||
|------|--------|------------|
|
||||
| Lead | Name | 100% |
|
||||
| Developer | Name | 50% |
|
||||
|
||||
## Risks
|
||||
|
||||
| Risk | Impact | Likelihood | Mitigation |
|
||||
|------|--------|------------|------------|
|
||||
| Risk 1 | High | Medium | Plan |
|
||||
|
||||
## Timeline
|
||||
|
||||
### Phase 1: Planning
|
||||
- [ ] Define requirements
|
||||
- [ ] Create design documents
|
||||
|
||||
### Phase 2: Development
|
||||
- [ ] Implement core features
|
||||
- [ ] Write tests
|
||||
|
||||
### Phase 3: Launch
|
||||
- [ ] Deploy to production
|
||||
- [ ] Monitor and iterate
|
||||
@@ -0,0 +1,38 @@
|
||||
# Project Name
|
||||
|
||||
Brief description of the project.
|
||||
|
||||
## Features
|
||||
|
||||
- Feature 1
|
||||
- Feature 2
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install project-name
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```javascript
|
||||
const project = require('project-name');
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
| Option | Default | Description |
|
||||
|--------|---------|-------------|
|
||||
| option1 | true | Description |
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork the repository
|
||||
2. Create your feature branch
|
||||
3. Commit your changes
|
||||
4. Push to the branch
|
||||
5. Open a Pull Request
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
@@ -0,0 +1,42 @@
|
||||
# Release Notes - v1.0.0
|
||||
|
||||
**Release Date:** {{DATE}}
|
||||
|
||||
## Highlights
|
||||
|
||||
Brief summary of the most important changes in this release.
|
||||
|
||||
## New Features
|
||||
|
||||
- **Feature 1:** Description of the new feature
|
||||
- **Feature 2:** Description of the new feature
|
||||
|
||||
## Improvements
|
||||
|
||||
- Improved performance of feature X
|
||||
- Updated dependency Y to version Z
|
||||
|
||||
## Bug Fixes
|
||||
|
||||
- Fixed issue where X would cause Y (#123)
|
||||
- Resolved crash when performing Z (#456)
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
- Changed API endpoint from `/old` to `/new`
|
||||
- Removed deprecated method `oldMethod()`
|
||||
|
||||
## Migration Guide
|
||||
|
||||
### From v0.9.x to v1.0.0
|
||||
|
||||
1. Update configuration file format
|
||||
2. Replace deprecated API calls
|
||||
|
||||
## Known Issues
|
||||
|
||||
- Issue description (#789)
|
||||
|
||||
## Contributors
|
||||
|
||||
Thanks to everyone who contributed to this release.
|
||||
@@ -0,0 +1,42 @@
|
||||
# Technical Specification: [Feature Name]
|
||||
|
||||
**Version:** 1.0
|
||||
**Date:** {{DATE}}
|
||||
**Author:** Your Name
|
||||
**Status:** Draft
|
||||
|
||||
## Overview
|
||||
|
||||
Brief description of what this feature does.
|
||||
|
||||
## Requirements
|
||||
|
||||
### Functional Requirements
|
||||
1. Requirement 1
|
||||
2. Requirement 2
|
||||
|
||||
### Non-Functional Requirements
|
||||
1. Performance requirement
|
||||
2. Security requirement
|
||||
|
||||
## Architecture
|
||||
|
||||
Describe the technical approach.
|
||||
|
||||
## API Design
|
||||
|
||||
### Endpoints
|
||||
|
||||
| Method | Path | Description |
|
||||
|--------|------|-------------|
|
||||
| GET | /api/resource | Get resource |
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
Describe how this will be tested.
|
||||
|
||||
## Timeline
|
||||
|
||||
| Phase | Duration | Deliverables |
|
||||
|-------|----------|-------------|
|
||||
| Phase 1 | 1 week | Core implementation |
|
||||
@@ -0,0 +1,71 @@
|
||||
# Tutorial: [Topic Name]
|
||||
|
||||
**Date:** {{DATE}}
|
||||
**Difficulty:** Beginner / Intermediate / Advanced
|
||||
**Time:** ~30 minutes
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Prerequisite 1
|
||||
- Prerequisite 2
|
||||
|
||||
## What You Will Learn
|
||||
|
||||
- Learning objective 1
|
||||
- Learning objective 2
|
||||
|
||||
## Step 1: Getting Started
|
||||
|
||||
Description of the first step.
|
||||
|
||||
```bash
|
||||
# Example command
|
||||
echo "Hello, World!"
|
||||
```
|
||||
|
||||
## Step 2: Core Concepts
|
||||
|
||||
Explain the main concepts here.
|
||||
|
||||
### Key Concept A
|
||||
|
||||
Details about concept A.
|
||||
|
||||
### Key Concept B
|
||||
|
||||
Details about concept B.
|
||||
|
||||
## Step 3: Building the Feature
|
||||
|
||||
Walk through the implementation.
|
||||
|
||||
```javascript
|
||||
// Example code
|
||||
function example() {
|
||||
return 'Hello';
|
||||
}
|
||||
```
|
||||
|
||||
## Step 4: Testing
|
||||
|
||||
How to verify everything works.
|
||||
|
||||
## Common Issues
|
||||
|
||||
### Issue 1
|
||||
**Problem:** Description of the problem.
|
||||
**Solution:** How to fix it.
|
||||
|
||||
### Issue 2
|
||||
**Problem:** Description of the problem.
|
||||
**Solution:** How to fix it.
|
||||
|
||||
## Next Steps
|
||||
|
||||
- Suggested follow-up 1
|
||||
- Suggested follow-up 2
|
||||
|
||||
## Resources
|
||||
|
||||
- [Resource 1](https://example.com)
|
||||
- [Resource 2](https://example.com)
|
||||
Reference in New Issue
Block a user