How to Contribute

Content Contributions

Adding a New Article

1. Create a new Markdown file in the content/ directory
2. Use the template file as a starting point
3. Follow the content guidelines below
4. Submit your changes via pull request

Content Template

---
title: "Your Article Title"
description: "A brief description of your article (one sentence)"
order: 1
---

## Introduction

Start with a brief introduction to the topic...

## Main Concept

Explain the main concept or idea...

### Sub-concept One

Break down complex ideas into smaller sections...

## Practical Applications

Provide real-world examples...

## Key Takeaways

1. First key point
2. Second key point
3. Third key point

## Conclusion

End with a thoughtful conclusion...

Content Guidelines

• Title: Clear, descriptive, and concise
• Description: One sentence that summarizes the article
• Order: (Optional) Add an order field in frontmatter to control sidebar sorting. Pages with order appear first (sorted by order value), followed by pages without order (sorted alphabetically by filename)
• Structure: Start with ## (h2) headings, not # (h1) - the title is already displayed from frontmatter
• Style: Maintain a minimalist, thoughtful tone
• No Emojis: Please do not use emojis in your content. We use minimal iconography instead to maintain a clean, professional aesthetic aligned with minimalist principles
• Length: Articles can be any length, but aim for clarity and depth
• Formatting: Use Markdown features like bold, italic, lists, and code blocks

Code Contributions

Setting Up Development

1. Fork the repository
2. Clone your fork: git clone https://github.com/your-username/minwiki.git
3. Install dependencies: npm install
4. Create a branch: git checkout -b feature/your-feature-name
5. Make your changes
6. Test locally: npm run dev
7. Build to check for errors: npm run build

Code Style

• Follow existing code patterns
• Use meaningful variable and function names
• Keep components focused and reusable
• Maintain the minimalist design aesthetic
• Ensure responsive design works on all screen sizes

Pull Request Process

Contribution Areas

Getting Help

• Open an issue for bugs or feature requests
• Ask questions in issue discussions
• Review existing issues before creating new ones

Code of Conduct

• Be respectful and inclusive
• Provide constructive feedback
• Focus on the content and code, not the person
• Help maintain a welcoming environment