|
| 1 | +--- |
| 2 | +title: Emoji Theme Packs |
| 3 | +--- |
| 4 | + |
| 5 | +# Emoji Theme Packs |
| 6 | + |
| 7 | +Emoji theme packs allow you to add domain-specific emoji prefixes to your README section headers. This can be a nice touch for enhancing visual navigation and project context. Each theme provides a carefully curated set of emojis aligned with different technology domains and project types. |
| 8 | + |
| 9 | +## Overview |
| 10 | + |
| 11 | +Use the `--emojis` flag along with your chosen theme to add emoji prefixes: |
| 12 | + |
| 13 | +```sh |
| 14 | +readmeai --emojis <theme_name> --repository <repository_url_or_path> |
| 15 | +``` |
| 16 | + |
| 17 | +## Available Themes |
| 18 | + |
| 19 | +### Core Themes |
| 20 | + |
| 21 | +=== ":octicons-mark-github-16: Default" |
| 22 | + |
| 23 | + Default theme *does not* include emojis. This is the default behavior when the `--emojis` flag is not set. |
| 24 | + |
| 25 | + ```sh |
| 26 | + readmeai --repository https://github.com/username/project |
| 27 | + ``` |
| 28 | + |
| 29 | + !!! example "Output Preview" |
| 30 | + |
| 31 | + ### Table of Contents |
| 32 | + - [Overview](#overview) |
| 33 | + - [Features](#features) |
| 34 | + - [Project Structure](#project-structure) |
| 35 | + - [Project Index](#project-index) |
| 36 | + - [Getting Started](#getting-started) |
| 37 | + - [Prerequisites](#prerequisites) |
| 38 | + - [Installation](#installation) |
| 39 | + - [Usage](#usage) |
| 40 | + - [Testing](#testing) |
| 41 | + - [Roadmap](#roadmap) |
| 42 | + - [Contributing](#contributing) |
| 43 | + - [License](#license) |
| 44 | + - [Acknowledgments](#acknowledgments) |
| 45 | + |
| 46 | +=== ":octicons-file-16: Minimal" |
| 47 | + |
| 48 | + Clean and simple emoji set. |
| 49 | + |
| 50 | + ```sh |
| 51 | + readmeai --emojis minimal --repository https://github.com/username/project |
| 52 | + ``` |
| 53 | + |
| 54 | + !!! example "Output Preview" |
| 55 | + |
| 56 | + ```markdown |
| 57 | + ## 📄 Table of Contents |
| 58 | + ## ✨ Overview |
| 59 | + ## 📌 Features |
| 60 | + ## 📁 Project Structure |
| 61 | + ### 📑 Project Index |
| 62 | + ## 🚀 Getting Started |
| 63 | + ### 📋 Prerequisites |
| 64 | + ### ⚙️ Installation |
| 65 | + ### 💻 Usage |
| 66 | + ### 🧪 Testing |
| 67 | + ## 📈 Roadmap |
| 68 | + ## 🤝 Contributing |
| 69 | + ## 📜 License |
| 70 | + ## ✨ Acknowledgments |
| 71 | + ``` |
| 72 | + |
| 73 | +=== ":octicons-code-16: OSS" |
| 74 | + |
| 75 | + Open source and community focused emojis. |
| 76 | + |
| 77 | + ```sh |
| 78 | + readmeai --emojis oss --repository https://github.com/username/project |
| 79 | + ``` |
| 80 | + |
| 81 | + !!! example "Output Preview" |
| 82 | + |
| 83 | + ```markdown |
| 84 | + ## 🌟 Table of Contents |
| 85 | + ## 💫 Overview |
| 86 | + ## ✨ Features |
| 87 | + ## 📁 Project Structure |
| 88 | + ### 📑 Project Index |
| 89 | + ## 🚀 Getting Started |
| 90 | + ### 📋 Prerequisites |
| 91 | + ### ⚙️ Installation |
| 92 | + ### 💻 Usage |
| 93 | + ### 🧪 Testing |
| 94 | + ## 👥 Community |
| 95 | + ### 🤝 Contributing |
| 96 | + ### 💭 Code of Conduct |
| 97 | + ### 🗣️ Discussions |
| 98 | + ### 🎯 Issues |
| 99 | + ## 📚 Documentation |
| 100 | + ### 📖 API Reference |
| 101 | + ### 📝 Tutorials |
| 102 | + ### 💡 Examples |
| 103 | + ## 📈 Roadmap |
| 104 | + ## ❤️ Contributors |
| 105 | + ## 📜 License |
| 106 | + ## ⭐ Acknowledgments |
| 107 | + ``` |
| 108 | + |
| 109 | +### Development Themes |
| 110 | + |
| 111 | +=== ":material-api: API" |
| 112 | + |
| 113 | + API and microservices focused emojis. |
| 114 | + |
| 115 | + ```sh |
| 116 | + readmeai --emojis api --repository https://github.com/username/project |
| 117 | + ``` |
| 118 | + |
| 119 | + !!! example "Output Preview" |
| 120 | + |
| 121 | + ```markdown |
| 122 | + ## 🔌 Table of Contents |
| 123 | + ## 🌐 Overview |
| 124 | + ## ⚡ Features |
| 125 | + ## 📁 Project Structure |
| 126 | + ### 📑 Project Index |
| 127 | + ## 🚀 Getting Started |
| 128 | + ### 📋 Prerequisites |
| 129 | + ### ⚙️ Installation |
| 130 | + ### 🔑 Authentication |
| 131 | + ### 🧪 Testing |
| 132 | + ## 📡 Endpoints |
| 133 | + ### 🔍 Queries |
| 134 | + ### 📝 Mutations |
| 135 | + ### 🔄 Subscriptions |
| 136 | + ### 🔒 Authorization |
| 137 | + ## ⚡ Performance |
| 138 | + ### 📊 Monitoring |
| 139 | + ### 🔍 Tracing |
| 140 | + ### 📈 Metrics |
| 141 | + ## 🛣️ Roadmap |
| 142 | + ## 🤝 Contributing |
| 143 | + ## 📜 License |
| 144 | + ## ⭐ Acknowledgments |
| 145 | + ``` |
| 146 | + |
| 147 | +=== ":material-web: Web" |
| 148 | + |
| 149 | + Web development focused emojis. |
| 150 | + |
| 151 | + ```sh |
| 152 | + readmeai --emojis web --repository https://github.com/username/project |
| 153 | + ``` |
| 154 | + |
| 155 | + !!! example "Output Preview" |
| 156 | + |
| 157 | + ```markdown |
| 158 | + ## 🌐 Table of Contents |
| 159 | + ## 💻 Overview |
| 160 | + ## ✨ Features |
| 161 | + ## 📁 Project Structure |
| 162 | + ### 📑 Project Index |
| 163 | + ## 🚀 Getting Started |
| 164 | + ### 📋 Prerequisites |
| 165 | + ### ⚙️ Installation |
| 166 | + ### 🖥️ Development |
| 167 | + ### 🧪 Testing |
| 168 | + ## 🎨 Frontend |
| 169 | + ### 🧩 Components |
| 170 | + ### 🔄 State Management |
| 171 | + ### 🎯 Routing |
| 172 | + ### 📱 Responsive Design |
| 173 | + ## ⚡ Backend |
| 174 | + ### 🛢️ Database |
| 175 | + ### 🔌 API |
| 176 | + ### 🔐 Authentication |
| 177 | + ### 📡 WebSockets |
| 178 | + ## 📱 Mobile Support |
| 179 | + ## 🚀 Deployment |
| 180 | + ### 🔄 CI/CD |
| 181 | + ### 📊 Monitoring |
| 182 | + ### 🔒 Security |
| 183 | + ## 📈 Roadmap |
| 184 | + ## 🤝 Contributing |
| 185 | + ## 📜 License |
| 186 | + ## ⭐ Acknowledgments |
| 187 | + ``` |
| 188 | + |
| 189 | +=== ":material-cellphone: Mobile" |
| 190 | + |
| 191 | + Mobile development focused emojis. |
| 192 | + |
| 193 | + ```sh |
| 194 | + readmeai --emojis mobile --repository https://github.com/username/project |
| 195 | + ``` |
| 196 | + |
| 197 | + !!! example "Output Preview" |
| 198 | + |
| 199 | + ```markdown |
| 200 | + ## 📱 Table of Contents |
| 201 | + ## 🌟 Overview |
| 202 | + ## ✨ Features |
| 203 | + ## 📁 Project Structure |
| 204 | + ### 📑 Project Index |
| 205 | + ## 🚀 Getting Started |
| 206 | + ### 📋 Prerequisites |
| 207 | + ### ⚙️ Installation |
| 208 | + ### 💻 Development |
| 209 | + ### 🧪 Testing |
| 210 | + ## 📱 Platforms |
| 211 | + ### 🤖 Android |
| 212 | + ### 🍎 iOS |
| 213 | + ### 🌐 Cross-Platform |
| 214 | + ## 🎨 UI/UX |
| 215 | + ### 🧩 Components |
| 216 | + ### 🎯 Navigation |
| 217 | + ### 🎨 Themes |
| 218 | + ### 📱 Responsive Design |
| 219 | + ## 📡 Backend |
| 220 | + ### 🔌 API Integration |
| 221 | + ### 💾 Data Storage |
| 222 | + ### 🔄 Sync |
| 223 | + ### 📶 Offline Support |
| 224 | + ## 📦 Distribution |
| 225 | + ### 🏗️ Build |
| 226 | + ### 📲 Deploy |
| 227 | + ### 🔄 Updates |
| 228 | + ## 📈 Analytics |
| 229 | + ## 🛣️ Roadmap |
| 230 | + ## 🤝 Contributing |
| 231 | + ## 📜 License |
| 232 | + ## ⭐ Acknowledgments |
| 233 | + ``` |
| 234 | + |
| 235 | +> [🚧 WORK IN PROGRESS] - Need to add the remaining theme examples. |
| 236 | +
|
| 237 | +## Configuration |
| 238 | + |
| 239 | +### Command-Line Options |
| 240 | + |
| 241 | +| Option | Description | Default | |
| 242 | +| :----- | :---------- | :------ | |
| 243 | +| `--emojis` | Specify emoji theme | `default` | |
| 244 | + |
| 245 | +### Creating Custom Themes |
| 246 | + |
| 247 | +You can create custom themes by adding them to your configuration: |
| 248 | + |
| 249 | +> [🚧 WORK IN PROGRESS] - Feature currently under development. |
| 250 | +
|
| 251 | +<!-- |
| 252 | +
|
| 253 | +```toml |
| 254 | +[themes.custom] |
| 255 | +name = "Custom Theme" |
| 256 | +description = "Your custom theme description" |
| 257 | +
|
| 258 | +[[themes.custom.sections]] |
| 259 | +title = "📚 Table of Contents" |
| 260 | +
|
| 261 | +[[themes.custom.sections]] |
| 262 | +title = "🎯 Overview" |
| 263 | +# ... add more sections |
| 264 | +``` |
| 265 | +
|
| 266 | +--> |
| 267 | + |
| 268 | +## Best Practices |
| 269 | + |
| 270 | +### When to Use Emojis |
| 271 | + |
| 272 | +✅ Recommended for: |
| 273 | +- Open source projects |
| 274 | +- Developer documentation |
| 275 | +- Technical blogs |
| 276 | +- Community resources |
| 277 | +- Educational content |
| 278 | + |
| 279 | +❌ Not recommended for: |
| 280 | +- Enterprise documentation |
| 281 | +- Legal documents |
| 282 | +- Compliance materials |
| 283 | +- Formal specifications |
| 284 | + |
| 285 | +### Theme Selection Guidelines |
| 286 | + |
| 287 | +1. **Match Project Domain** |
| 288 | + - Choose themes that reflect your project's technology stack |
| 289 | + - Use domain-specific themes for specialized projects |
| 290 | + - Consider your target audience |
| 291 | + |
| 292 | +2. **Maintain Consistency** |
| 293 | + - Use one theme throughout documentation |
| 294 | + - Keep emoji usage consistent |
| 295 | + - Follow theme patterns |
| 296 | + |
| 297 | +3. **Ensure Readability** |
| 298 | + - Don't overuse emojis |
| 299 | + - Test readability across platforms |
| 300 | + - Consider color contrast |
| 301 | + |
| 302 | +4. **Consider Platform Support** |
| 303 | + - Test emoji rendering |
| 304 | + - Check platform compatibility |
| 305 | + - Verify display across devices |
| 306 | + |
| 307 | +## FAQs |
| 308 | + |
| 309 | +??? question "Can I mix themes?" |
| 310 | + While possible, it's recommended to stick to one theme for consistency. |
| 311 | + |
| 312 | +??? question "How do I preview themes?" |
| 313 | + Use the `--dry-run` flag to preview theme output without generating a README. |
| 314 | + |
| 315 | +??? question "Can I disable emojis for specific sections?" |
| 316 | + Yes, use the `--no-emoji` flag for specific sections in custom themes. |
| 317 | + |
| 318 | +<!-- |
| 319 | +## Tips and Tricks |
| 320 | +
|
| 321 | +1. **Theme Testing** |
| 322 | + ```sh |
| 323 | + readmeai --emojis <theme> --dry-run |
| 324 | + ``` |
| 325 | +
|
| 326 | +2. **Custom Theme Creation** |
| 327 | + ```sh |
| 328 | + readmeai --emojis custom --theme-file path/to/theme.toml |
| 329 | + ``` |
| 330 | +
|
| 331 | +3. **Section Override** |
| 332 | + ```sh |
| 333 | + readmeai --emojis <theme> --no-emoji-sections "overview,features" |
| 334 | + ``` |
| 335 | +
|
| 336 | +!!! tip "Tip: Theme Preview" |
| 337 | + Use the `--preview` flag to see how your README will look with different themes before generating. |
| 338 | +
|
| 339 | +!!! warning "Platform Compatibility" |
| 340 | + Some platforms or markdown renderers may display emojis differently. Always test your documentation's appearance on target platforms. |
| 341 | +--> |
| 342 | + |
| 343 | +## See Also |
| 344 | + |
| 345 | +- [Configuration Reference](cli_reference.md) |
| 346 | +- [Header Styles Reference](components/headers.md) |
| 347 | +- [Markdown Formatting Guide](guides/markdown.md) |
| 348 | + |
| 349 | +--- |
0 commit comments