Docsy

Formatting & Structure

• Use TOML frontmatter for all content files
• Follow Hugo’s content organization with _index.md for sections
• Use consistent weight values for navigation ordering
• Keep markdown files clean with proper heading hierarchy
• Use Hugo shortcodes for complex content blocks

Content & Navigation

• Include proper frontmatter: title, description, type, weight
• Use descriptive page titles and meta descriptions
• Organize content in logical directory structures
• Set up proper menu navigation with parent-child relationships
• Use no_list: true to exclude pages from section listings

Best Practices & Tools

• Test responsive design across different screen sizes
• Validate Hugo build process with hugo --gc --minify
• Use Hugo’s built-in syntax highlighting for code blocks
• Implement proper search functionality with Docsy’s search features
• Follow accessibility guidelines for documentation sites

References

• Docsy theme documentation
• Hugo content management