// Docusaurus Best Practices
const docusaurusBestPractices = [
"Use Markdown and MDX for content creation",
"Implement proper frontmatter for metadata",
"Utilize code blocks with syntax highlighting",
"Use admonitions for important notes",
"Implement proper internal/external linking",
"Use versioning for documentation when needed",
"Optimize images and assets",
];
// Documentation Structure
const docsStructure = [
"Start with clear introduction",
"Group related content in categories",
"Use consistent heading hierarchy",
"Include practical examples",
"Add interactive components when needed",
"Provide troubleshooting guides",
"Include API documentation if applicable",
];
// Blog Post Guidelines
const blogPostGuidelines = [
"Use descriptive titles",
"Include publication date",
"Add proper tags and categories",
"Use featured images",
"Implement proper SEO metadata",
"Include author information",
"Add reading time estimation",
];
// Folder structure
const folderStructure = `
docs/
intro.md
category/
doc1.md
doc2.md
blog/
2024-03-20-blog-post.md
authors.yml
src/
components/
css/
pages/
static/
img/
sidebars.js
docusaurus.config.js
`;
// Markdown Frontmatter Templates
const docFrontmatterTemplate = `
---
id: unique-doc-id
title: Document Title
sidebar_label: Sidebar Label
description: SEO description
keywords: [keyword1, keyword2]
---
`;
const blogFrontmatterTemplate = `
---
slug: post-url
title: Blog Post Title
authors: [author1, author2]
tags: [tag1, tag2]
image: ./img/blog/featured.png
date: 2024-03-20
---
`;
// Additional Guidelines
const additionalGuidelines = `
1. Use consistent formatting across all documents
2. Implement proper sidebar organization
3. Utilize Docusaurus features (tabs, cards, etc.)
4. Add search functionality
5. Implement proper i18n if needed
6. Use responsive images
7. Follow accessibility guidelines
8. Add proper documentation footer
9. Implement dark/light mode support
10. Use proper metadata for SEO
`;
// Writing Style Guide
const writingStyleGuide = `
1. Use clear and concise language
2. Follow technical writing principles
3. Include code examples when relevant
4. Use proper heading structure (H1 > H2 > H3)
5. Add table of contents for long documents
6. Include relevant screenshots/diagrams
7. Provide external references when needed
`;
//Output language
const outputLanguage = "ko";
css
golang
typescript
First Time Repository
blog & portpolio
TypeScript
Languages:
CSS: 2.5KB
TypeScript: 15.4KB
Created: 5/23/2017
Updated: 1/20/2025
All Repositories (1)
blog & portpolio