5 |
6 |
7 |
2 |
3 |
4 |
5 |
6 |
7 |
19 | 
20 | 
21 | 
28 |
29 |
30 | # Document My Project
31 |
32 | Easily create markdown documentation for your project
33 |
34 | 
 |
76 |  |
77 |
 |
80 |  |
81 |
3 |
4 | Easily create markdown documentation for your project
5 | 17 |
3 | 4 | 5 | {{ title }} 6 |
7 |
163 | `;
164 |
165 | const npmDownloadsBadge = `
166 | 
167 | `;
168 |
169 | const bundleSizeBadge = `
170 | 
171 | `;
172 |
173 | const badges = `174 | ${npmVersionBadge} 175 | ${npmDownloadsBadge} 176 | ${bundleSizeBadge} 177 |
`; 178 | 179 | return badges; 180 | } 181 | 182 | generateTableOfContentsFromMarkdown(markdownText: string, addTitleIcons = false): string { 183 | const headingRegex = /^(#{1,6})\s*(.*?)$/gm; 184 | const slugify = (text: string) => 185 | text 186 | .toLowerCase() 187 | .replace(/\s+/g, '-') 188 | .replace(/[^a-z0-9-]/g, ''); 189 | 190 | const headings: { text: string; level: number }[] = []; 191 | let match: RegExpExecArray | null; 192 | 193 | while ((match = headingRegex.exec(markdownText))) { 194 | const level = match[1].length; 195 | const text = match[2].trim(); 196 | headings.push({text, level}); 197 | } 198 | 199 | let tableOfContents = this.generateTitle(`${addTitleIcons ? '📝 ' : ''}️Table of Contents`) + '\n
230 | 
231 | 
232 | 
';
280 | images.forEach(image => {
281 | markdownContent += ``;
282 | });
283 | return markdownContent + '
${addIcon ? 'Top ⬆️' : '(Back to top)'}
`; 347 | } 348 | 349 | generateLicenseSection(licenseSection: LicenseOptions, addTitleIcons = false): string { 350 | const {type, customText} = licenseSection; 351 | let licenseSectionContent = this.generateTitle(`${addTitleIcons ? '📖 ' : ''}License`,) + '\n\n'; 352 | 353 | switch (type) { 354 | case 'MIT': 355 | licenseSectionContent += 'This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).\n'; 356 | break; 357 | case 'Apache-2.0': 358 | licenseSectionContent += 'This project is licensed under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).\n'; 359 | break; 360 | case 'GPL-3.0': 361 | licenseSectionContent += 'This project is licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).\n'; 362 | break; 363 | case 'BSD-3-Clause': 364 | licenseSectionContent += 'This project is licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause).\n'; 365 | break; 366 | case 'Custom': 367 | if (customText) { 368 | licenseSectionContent += `${customText}\n`; 369 | } else { 370 | licenseSectionContent += 'This project is licensed under a custom license.\n'; 371 | } 372 | break; 373 | default: 374 | licenseSectionContent += 'This project is licensed under an unspecified license.\n'; 375 | } 376 | 377 | return licenseSectionContent; 378 | } 379 | 380 | generateFeaturesSection(features: FeatureOptions[], addTitleIcons = false): string { 381 | let featuresSection = this.generateTitle(`${addTitleIcons ? '⭐️ ' : ''}Features`) + '\n\n'; 382 | 383 | features.forEach((feature, index) => { 384 | const {title, description} = feature; 385 | featuresSection += `${index + 1}. **${title}**\n\n${description}\n\n`; 386 | }); 387 | 388 | return featuresSection; 389 | } 390 | 391 | generateTitle(titleName: string) { 392 | return `## ${titleName}`; 393 | } 394 | 395 | generateIntroductionSection(title: string, description: string, url: string, imgUrl: string) { 396 | return ` 397 |
401 | ` : ''}
402 |
403 | # ${title}
404 |
405 | ${description}
406 |
407 | | \n'; 575 | } 576 | } 577 | 578 | showcaseSection += ' |