This guide explains how to manage content in the Resources section using our Git-based workflow.
Content Structure
File Location
All resource content is stored in the src/content/resources directory as Markdown (.md) files.
Required Frontmatter
Every resource file must include these fields at the top:
---
title: "Your Title Here"
description: "Brief, compelling description"
date: "YYYY-MM-DD"
author: "Author Name"
image: "category/image-name.jpg"
category: "Category Name"
featured: false
---
Adding New Content
1. Create New File
- Use descriptive, URL-friendly filenames
- Use kebab-case:
your-article-title.md - Place in
src/content/resources/
2. Write Content
Use Markdown formatting:
## Main Heading
Regular paragraph text with **bold** and *italic* emphasis.
### Subheading
- List item one
- List item two
- List item three
1. Numbered item one
2. Numbered item two
3. Numbered item three
3. Best Practices
- Start with a clear introduction
- Use proper heading hierarchy (## for sections)
- Include practical, actionable information
- End with relevant calls to action
- Keep paragraphs concise
- Use lists for better readability
4. Image Guidelines
- Store images in the appropriate category folder
- Use descriptive filenames
- Recommended dimensions:
- Featured images: 1920×1080px
- Regular images: 1200×675px
- Optimize images before upload
- Use proper alt text
- Include image credits when required
Content Organization
Categories
Current categories include:
- Maintenance
- Buying Guide
- Training
- Community
- Events
- Documentation
Featured Content
- Only one article should be marked as
featured: true - Featured articles appear prominently at the top of the resources page
- Update featured status by modifying the frontmatter
Workflow
1. Local Development
# Create new content
1. Create .md file in src/content/resources/
2. Add frontmatter and content
3. Run dev server to preview
4. Test all links and formatting
2. Version Control
# Commit changes
1. Stage new/modified files
2. Commit with descriptive message
3. Push to repository
3. Deployment
- Site automatically rebuilds when changes are pushed
- New content is live within minutes
- No additional deployment steps needed
Content Guidelines
Writing Style
- Use clear, concise language
- Write in active voice
- Address reader directly
- Include practical examples
- Break up long content with subheadings
Images
- Use high-quality images
- Choose relevant, visually appealing images
- Ensure proper licensing
- Optimize for web performance
- Follow the image naming convention
- Include descriptive alt text
SEO Best Practices
- Use descriptive titles
- Write compelling descriptions
- Include relevant keywords naturally
- Use proper heading hierarchy
- Add alt text for images
Maintenance
Regular Tasks
- Review content monthly
- Update outdated information
- Fix broken links
- Update images if needed
- Refresh featured content
Content Calendar
- Plan content in advance
- Maintain consistent publishing schedule
- Coordinate with events and promotions
- Track content performance
Example Article Structure
---
title: "Essential Bike Maintenance Tips"
description: "Learn the fundamental maintenance tasks every cyclist should know"
date: "2024-02-21"
author: "Michael Thompson"
image: "maintenance/basic-maintenance-guide.jpg"
category: "Maintenance"
featured: false
---
Introduction paragraph explaining the importance of the topic...
## Main Topic One
Detailed explanation with key points...
### Subtopic
Specific details and examples...
## Main Topic Two
More content with practical tips...
## Conclusion
Summary and call to action...
Need Help?
If you have questions about content management:
- Review this guide
- Check existing articles for examples
- Contact the technical team
- Submit questions through the repository
Remember, quality content helps our community and improves our search engine visibility. Take time to create valuable, well-structured resources that benefit our readers.