Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 100 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# 📚 Documentation

Welcome to the doocs/md documentation! This directory contains comprehensive guides to help you get the most out of our WeChat Markdown editor.

---

## 📖 Documentation Index

### 🚀 Getting Started

| Document | Description | For |
|----------|-------------|-----|
| [getting-started.md](./getting-started.md) | Complete onboarding guide with all deployment options | New users |
| [markdown-guide.md](./markdown-guide.md) | Full Markdown syntax reference with examples | All users |
| [example-content.md](./example-content.md) | Ready-to-use article templates | Content creators |

### ⚙️ Configuration Guides

| Document | Description |
|----------|-------------|
| [custom-upload.md](./custom-upload.md) | How to set up custom image upload endpoints |
| [mp-card.md](./mp-card.md) | WeChat Mini Program card configuration |
| [telegram-usage.md](./telegram-usage.md) | Setting up Telegram as image hosting |

---

## 🎯 Quick Start Paths

### Path 1: I'm New Here 👶

1. Read [getting-started.md](./getting-started.md) for an overview
2. Try the [online editor](https://md.doocs.org)
3. Reference [markdown-guide.md](./markdown-guide.md) while writing

### Path 2: I Want to Write Better Articles ✍️

1. Check [example-content.md](./example-content.md) for templates
2. Learn advanced syntax from [markdown-guide.md](./markdown-guide.md)
3. Experiment with custom CSS styling

### Path 3: I Need Self-Hosting 🏠

1. Follow Docker deployment in [getting-started.md](./getting-started.md)
2. Configure your preferred [image hosting](./custom-upload.md)
3. Set up [Telegram integration](./telegram-usage.md) (optional)

---

## 🌟 Featured Content

### What's New

- 🆕 **Getting Started Guide** - Complete onboarding for new users
- 🆕 **Markdown Reference** - Comprehensive syntax documentation
- 🆕 **Example Templates** - Ready-to-use article templates

### Popular Topics

- 🐳 Docker deployment
- 🖼️ Image hosting configuration
- 🤖 AI integration setup
- 📝 Markdown syntax tips

---

## 📝 Contributing to Documentation

We welcome contributions! If you find errors or want to improve our docs:

1. Fork the repository
2. Make your changes
3. Submit a pull request

See our [Contributing Guide](../CONTRIBUTING.md) for details.

---

## 🔗 External Resources

- [Main README](../README.md) - Project overview and features
- [GitHub Issues](https://github.com/doocs/md/issues) - Bug reports and feature requests
- [Discussions](https://github.com/doocs/md/discussions) - Community Q&A
- [Online Editor](https://md.doocs.org) - Try it now!

---

## 🗂️ Document Status

| Document | Last Updated | Status |
|----------|--------------|--------|
| getting-started.md | 2026-04-05 | ✅ Complete |
| markdown-guide.md | 2026-04-05 | ✅ Complete |
| example-content.md | 2026-04-05 | ✅ Complete |
| custom-upload.md | 2026-03-26 | ✅ Stable |
| mp-card.md | 2026-03-26 | ✅ Stable |
| telegram-usage.md | 2026-03-26 | ✅ Stable |

---

*Need help? Check our [Getting Started Guide](./getting-started.md) or join our [community discussions](https://github.com/doocs/md/discussions)!*
Loading