🤔 What is this template all about?

• This template can be used as a base layer for a GitHub profile page.
• Make the project easy to maintain with 7 issue templates.
• Quick-start documentation with an extraordinary README structure.
• Manage issues with 20 issue labels.
• Make community healthier with all the guides like code of conduct, contributing, support, security...
• Learn more with the official GitHub guide on creating repositories from a template.
• To start using it, click Use this template to create your new repository.

---

✨ Documentation

Getting-started guidance, feature details, and API reference documentation.

Getting Started

Tip

Install Prerequisites:

• Node LTS version
• pnpm
• Git

# Clone the repository
git clone https://github.com/IQKV/standard-docs-vitepress-project-layout.git my-docs

# Navigate to project directory
cd my-docs

# Install dependencies
pnpm install

# Start development server
pnpm docs:dev

Available Scripts

Command	Description
pnpm docs:dev	Start development server
pnpm docs:build	Build for production
pnpm docs:preview	Preview production build
pnpm prettier:write	Run Prettier over the code
pnpm lint	Lint code

Environment Variables

Variable	Description	Default
NODE_ENV	Defines nodejs environment	development

---

📆 Changelog

Conventional changelog located here.

👍 Acknowledgments

...

🙏 Community & Contributions

Please follow Contributing page.

📙 Code of Conduct

Please follow Code of Conduct page.

💥 Troubleshooting

...

📑 License

This project is licensed under the MIT License. See the LICENSE file for more details.

GitHub Project Tooling Overview

Core Framework & Build Tools

• VitePress - Static site generator for documentation
• Vue - Frontend framework
• pnpm - Package manager with workspace support

Development Scripts

Command	Description
pnpm docs:dev	Start development server
pnpm docs:build	Build for production
pnpm docs:preview	Preview production build
pnpm prettier:write	Format code with Prettier
pnpm lint	Lint code (prettier check)
pnpm release	Create release with release-it

Code Quality & Formatting

• Prettier - Code formatting with packagejson plugin
• Lint-staged - Run linters on staged files
• EditorConfig - Consistent editor settings

Git Workflow & Automation

• Husky - Git hooks management
• Commitlint - Enforce conventional commits
• Commitizen - Interactive commit message generator
• Pre-commit hooks - Automatic code formatting before commits

Release Management

• Release-it - Automated release workflow
• Conventional Changelog - Generate changelog from commits
• Release-it-pnpm - pnpm integration for releases

GitHub Workflow Automation

• Build validation - Node.js project build checks
• PR title validation - Enforce conventional PR titles
• Commit message validation - Verify commit format
• Template cleanup - Post-template setup automation
• Dependabot - Automated dependency updates

Community & Documentation

• Issue templates (7 templates) - Standardized issue reporting
• Issue labels (20 labels) - Organized issue categorization
• Community health files - Contributing, CoC, Security, Support guides
• Dev container - Containerized development environment