oleeskild/obsidian-digital-garden
Obsidian Digital Garden
This project is an Obsidian plugin that functions as a static site generator, designed to transform local markdown note vaults into public-facing websites. It automates the conversion of structured text files into a live knowledge base, enabling users to share personal research and documentation directly from their local storage.
The platform distinguishes itself through a security-first approach to content management, utilizing frontmatter-based flags to ensure that only explicitly marked notes are published to the web. This selective publishing mechanism prevents the accidental exposure of private vault data, while a git-based deployment pipeline automates the synchronization of content to remote hosting providers.
The system supports a broad range of site management capabilities, including the generation of interactive navigation tools like file trees and backlink discovery. It also provides extensive options for visual customization through template-driven layouts and style overrides, allowing for the integration of rich media such as diagrams and mathematical equations within the published output.
Features
- Digital Garden Frameworks - Provides a framework for publishing networked personal knowledge bases as websites with interactive navigation and backlink discovery.
- Static Site Generators - Transforms local markdown files into a complete static website for public knowledge sharing.
- Publishing Extensions - Extends the local note-taking application to automate the publishing and deployment of markdown content to the web.
- Private Content Access Controls - Restricts public visibility of notes using explicit frontmatter flags to prevent accidental exposure.
- Knowledge Base Publishing - Enables users to share personal knowledge bases directly from their local storage to the web.
- Markdown Site Publishing - Transforms collections of local markdown files into structured, navigable web presences for public knowledge sharing.
- Frontmatter Management - Uses frontmatter metadata to programmatically determine which notes are included in the public build.
- Git-Push Deployments - Automates site deployment by triggering build pipelines upon pushing content to a version-controlled repository.
- Public Access Blocks - Ensures only explicitly marked notes are uploaded to the web, acting as a safety block against private data exposure.
- Template-Driven Generators - Uses predefined layout templates to inject markdown content into consistent site structures.
- Static Site Deployment Tools - Automates the deployment of generated static documentation sites to cloud hosting providers.
- Rich Content Rendering - Renders complex content like diagrams and mathematical equations within published notes.
- Client-Side Search Indices - Generates a searchable index of all published notes for client-side discovery without requiring a backend.
- Technical Content Sites - Supports the integration of custom templates and interactive components to extend site functionality for technical content.
- Site Navigation Generators - Automatically parses content to generate site navigation structures and link indexes for improved discoverability.
- Local File Syncing - Syncs local markdown directories to remote hosting providers to keep published content updated.
- Cloud or Self-Hosted Deployments - Automates the deployment of static content to various cloud hosting providers.
- Selective Publishing Workflows - Ensures only explicitly marked notes are published to the web, preventing accidental exposure of private vault data.
- Repository Access Controls - Limits deployment credentials to specific projects to prevent unauthorized access to sensitive vault data.
- CSS Variable Theming - Maps design tokens to native CSS variables to enable user-defined visual themes and style overrides.
- Site-Specific Layouts - Allows structural customization of the site layout to align with specific branding and design goals.
- Site-Wide Theme Controls - Provides site-wide theme controls and CSS overrides to customize the visual appearance of the published knowledge base.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
