This directory contains the official documentation for the Hoverkraft Docusaurus theme, built using the theme itself as a demonstration.
This documentation site serves dual purposes:
- Comprehensive documentation for the Hoverkraft theme
- Live demonstration of the theme's features and capabilities
pnpm installpnpm --filter hoverkraft-theme-docs run startThis starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.
pnpm --filter hoverkraft-theme-docs run buildThis command generates static content into the build directory and can be served using any static content hosting service.
- Getting Started: Introduction and installation guide
- Installation: Detailed setup instructions
- Configuration: Complete configuration reference
- Components: Documentation for Layout, Footer, and Logo components
- Customization: Guides for colors, typography, and custom CSS
- Migration: Guide for migrating from other themes
This site showcases all theme features:
- ✅ Hoverkraft branding applied throughout
- ✅ Responsive design across all screen sizes
- ✅ Custom components in action
- ✅ Professional typography for documentation
- ✅ Color system with primary, secondary, and accent colors
- ✅ Footer and header styling
- ✅ Blog functionality with theme styling
The site uses this configuration to demonstrate the theme:
// docusaurus.config.js
hoverkraft: {
colors: {
primary: '#007acc',
secondary: '#6c757d',
accent: '#ff6b35',
},
}To contribute to the documentation:
- Edit the relevant Markdown files in
packages/docs/content - Update configuration in
packages/docs/docusaurus.config.jsif needed - Test changes locally with
pnpm --filter hoverkraft-theme-docs run start - Submit a pull request
The documentation is automatically deployed when changes are pushed to the main branch.