mirror of
https://github.com/amitwh/markdown-converter.git
synced 2026-08-02 18:10:18 +05:30
style: run prettier formatter over src and tests
This commit is contained in:
+10
-10
@@ -22,10 +22,10 @@ GET /resources
|
||||
|
||||
**Query Parameters:**
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
|-----------|------|----------|-------------|
|
||||
| page | integer | No | Page number (default: 1) |
|
||||
| limit | integer | No | Items per page (default: 20) |
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ------- | -------- | ---------------------------- |
|
||||
| page | integer | No | Page number (default: 1) |
|
||||
| limit | integer | No | Items per page (default: 20) |
|
||||
|
||||
**Response:**
|
||||
|
||||
@@ -82,9 +82,9 @@ DELETE /resources/:id
|
||||
|
||||
## Error Codes
|
||||
|
||||
| Code | Description |
|
||||
|------|-------------|
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 404 | Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
| Code | Description |
|
||||
| ---- | --------------------- |
|
||||
| 400 | Bad Request |
|
||||
| 401 | Unauthorized |
|
||||
| 404 | Not Found |
|
||||
| 500 | Internal Server Error |
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Blog Post Title
|
||||
date: {{DATE}}
|
||||
date: { { DATE } }
|
||||
author: Your Name
|
||||
tags: []
|
||||
---
|
||||
|
||||
@@ -3,18 +3,23 @@
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
|
||||
- New feature
|
||||
|
||||
### Changed
|
||||
|
||||
- Updated feature
|
||||
|
||||
### Fixed
|
||||
|
||||
- Bug fix
|
||||
|
||||
### Removed
|
||||
|
||||
- Removed feature
|
||||
|
||||
## [1.0.0] - {{DATE}}
|
||||
|
||||
### Added
|
||||
|
||||
- Initial release
|
||||
|
||||
+20
-16
@@ -9,50 +9,54 @@ 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 |
|
||||
| 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 |
|
||||
| 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 |
|
||||
| Metric | Option A | Option B |
|
||||
| ----------- | -------- | --------- |
|
||||
| Speed | Fast | Moderate |
|
||||
| Memory | Low | Medium |
|
||||
| Scalability | Good | Excellent |
|
||||
|
||||
## Recommendation
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
**Date:** {{DATE}}
|
||||
**Attendees:**
|
||||
|
||||
- Name 1
|
||||
- Name 2
|
||||
|
||||
|
||||
@@ -12,43 +12,48 @@
|
||||
## 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 |
|
||||
| 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% |
|
||||
| Role | Person | Allocation |
|
||||
| --------- | ------ | ---------- |
|
||||
| Lead | Name | 100% |
|
||||
| Developer | Name | 50% |
|
||||
|
||||
## Risks
|
||||
|
||||
| Risk | Impact | Likelihood | Mitigation |
|
||||
|------|--------|------------|------------|
|
||||
| Risk 1 | High | Medium | Plan |
|
||||
| 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
|
||||
|
||||
@@ -21,9 +21,9 @@ const project = require('project-name');
|
||||
|
||||
## Configuration
|
||||
|
||||
| Option | Default | Description |
|
||||
|--------|---------|-------------|
|
||||
| option1 | true | Description |
|
||||
| Option | Default | Description |
|
||||
| ------- | ------- | ----------- |
|
||||
| option1 | true | Description |
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
@@ -12,10 +12,12 @@ 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
|
||||
|
||||
@@ -27,9 +29,9 @@ Describe the technical approach.
|
||||
|
||||
### Endpoints
|
||||
|
||||
| Method | Path | Description |
|
||||
|--------|------|-------------|
|
||||
| GET | /api/resource | Get resource |
|
||||
| Method | Path | Description |
|
||||
| ------ | ------------- | ------------ |
|
||||
| GET | /api/resource | Get resource |
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
@@ -37,6 +39,6 @@ Describe how this will be tested.
|
||||
|
||||
## Timeline
|
||||
|
||||
| Phase | Duration | Deliverables |
|
||||
|-------|----------|-------------|
|
||||
| Phase 1 | 1 week | Core implementation |
|
||||
| Phase | Duration | Deliverables |
|
||||
| ------- | -------- | ------------------- |
|
||||
| Phase 1 | 1 week | Core implementation |
|
||||
|
||||
@@ -42,7 +42,7 @@ Walk through the implementation.
|
||||
```javascript
|
||||
// Example code
|
||||
function example() {
|
||||
return 'Hello';
|
||||
return 'Hello';
|
||||
}
|
||||
```
|
||||
|
||||
@@ -53,10 +53,12 @@ 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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user