How actualbudget/docs works
This repository is the Actual Budget community documentation website, not the budgeting application itself. A reader visits the site to find guidance, follow setup or usage instructions, and learn about the project. The map emphasizes the documented product areas and the site’s content-rendering layer; README and sampled source support the site configuration and mention plugin, but not the internal implementation of Docusaurus or every documentation page.
Main entry points: docs Guides and reference · docusaurus.config.js Site configuration · MDXComponents.js MDX components · docs-sidebar.js Navigation structure
Components 22
Documentation content
- Guides and reference
docs - Installation and setup
docs/install - Budgeting guidance
docs/budgeting - Accounts and transactions
docs/accounts - Transaction guidance
docs/transactions - Bank synchronization
docs/advanced/bank-sync - Reports guidance
docs/reports - Backup and restore
docs/backup-restore - API and ActualQL
docs/api - Experimental features
docs/experimental - Release blog
blog
Website experience
- Docusaurus site
- Site configuration
docusaurus.config.js - Homepage
src/pages/index.js - Page layout
src/theme/Layout/index.js - MDX components
src/theme/MDXComponents.js - Navigation structure
docs-sidebar.js
Content extensions
- GitHub mentions
src/remark/mentions.js - Responsive images
src/components/Image.jsx - Keyboard display
src/components/Key.jsx - Local search
Other components
- Reader
Connections 22
- Reader → Docusaurus site: browses
- Docusaurus site → Homepage: serves
- Docusaurus site → Guides and reference: renders
- Docusaurus site → Release blog: renders
- Docusaurus site → Page layout: uses
- Docusaurus site → Site configuration: configured by
- Site configuration → Navigation structure: loads
- Navigation structure → Guides and reference: organizes
- Guides and reference → Installation and setup: includes
- Guides and reference → Budgeting guidance: includes
- Guides and reference → Accounts and transactions: includes
- Guides and reference → Transaction guidance: includes
- Guides and reference → Bank synchronization: includes
- Guides and reference → Reports guidance: includes
- Guides and reference → Backup and restore: includes
- Guides and reference → API and ActualQL: includes
- Guides and reference → Experimental features: includes
- Site configuration → GitHub mentions: registers
- MDX components → Responsive images: uses
- MDX components → Keyboard display: uses
- Site configuration → Local search: enables
- Docusaurus site → MDX components: renders with