🔥FLASH SALE: 30% OFF everything!
LogoTemplateFame
icon of astro big doc

astro big doc

Astro Theme for comprehensive documentation, featuring zero-config hierarchical menus, dynamic table of contents, and rich Markdown rendering with int...

Introduction

Astro Big Doc is a powerful Astro theme specifically designed for creating comprehensive documentation websites with a zero-configuration approach. It transforms standard Markdown (.md) files into rich, interactive content using custom Astro components.

Key features include:

  • Zero-Config Navigation: Automatically generates hierarchical menus and a table of contents based on your file structure, simplifying site setup.
  • Enhanced Markdown Rendering: Extends native Markdown capabilities with custom Astro components for a dynamic user experience.
  • Interactive Images: Implements panzoom and modal functionalities for images, supporting URL parameters for auto-opening, text focusing, and state restoration. Includes directives for image centering and sizing.
  • Advanced Galleries: Offers both SVG image galleries with expand/collapse options and Photoswipe galleries with smooth transitions.
  • Dynamic Tables: Converts standard Markdown tables into interactive DataTables, and can also render tables directly from .xlsx files.
  • Code Integration: Provides VSCode-like syntax highlighting using Shikiji for code blocks, complete with a convenient copy button.
  • Diagram Generation: Renders diagrams directly from code blocks or linked code files, supporting PlantUML and all formats compatible with Kroki. Users can easily toggle between the diagram and its source code.
  • 3D Model Viewer: Integrates a 3D model viewer for .glb files or models defined via YAML parameters within Markdown.
  • Content Structuring: Includes Markdown Note asides (Note, Tip, Caution, Danger) and collapsible Details blocks for organized content presentation.
  • Flexible Asset Management: Supports both relative and absolute asset paths with zero-copy during development, streamlining asset integration.
  • External Link Handling: Automatically identifies and renders external links with a distinct arrow icon.
  • Interactive SVGs: Allows for interactive SVG diagrams through YAML metadata, enabling features like clickable links and text highlighting on hover.
  • User-Friendly Interface: Features collapsible and width-adjustable side menus for an optimized browsing experience.

Astro Big Doc aims to provide a robust and flexible solution for developers and technical writers to create highly interactive and easily navigable documentation portals.

Information

Newsletter

Join the Community

Subscribe to our newsletter for the latest news and updates