A modular Obsidian vault system designed for scalable, compartmentalized project management. The Apparatus enables you to maintain context-specific vaults while sharing components across installations through Git submodules.
- What is the Apparatus?
- Why Modular Architecture?
- Core Components
- Module System
- Getting Started
- Development
The LVNACY Apparatus is a preconfigured Obsidian vault system that combines essential plugins, CSS snippets, templates, and automation scripts into a cohesive framework. It's built around the principle that managing information across multiple specialized projects requires both consistency and flexibility.
The Apparatus philosophy recognizes that you may be working with different types of content—-stories, research libraries, project documentation, knowledge bases—-each with its own workflow and structure. Rather than forcing everything into a single vault configuration, the Apparatus allows you to spin up context-specific vaults quickly while maintaining the ability to share libraries and components across installations.
Each module maintains its own git repository and version control history. This separation means you can track changes specific to each module without cluttering the main vault's history. Updates to one module don't affect others.
Modules are self-contained units that can be easily shared, moved, or reused across different Apparatus vaults. A module that works in one vault will work in another without modification. You can maintain multiple specialized vaults while reusing common infrastructure.
The compartmentalization model allows the Apparatus ecosystem to grow organically. Different module types—for story development, research libraries, documentation, image management—can be added independently without affecting existing modules or the core vault structure.
Context-specific notes remain siloed in their respective vaults while shared resources (libraries, references, assets) are managed as independent modules via git submodules.
- Dataview - Query and visualize data within your vault
- Templater - Advanced template functionality with JavaScript support
- Custom File Explorer Sort - Organize file explorer with custom rules
- Longform - Writing and editing support for long-form content
- PDF++ - Enhanced PDF document support
- Folder Notes - Create notes at the folder level
- Iconic - Add icons to files and folders for visual navigation
- Style Settings - Unified settings interface for theme and plugins
- JavaScript automation scripts for templating and project scaffolding
- Templater integration for dynamic content generation
- Service utilities for note management and vault structure operations
- Codescript Toolkit support for extending functionality
- CSS snippets for advanced layout and visual customization
- Author callout styling
- Multicolumn note layouts
- Folder header enhancements
- Paragraph writing formatting
- Dataview cheatsheet and reference materials
- Templater user guide and function reference
- Callout style reference for consistent visual communication
- Plugin-specific documentation for quick access
Modules are installed as Git submodules within an Apparatus vault. Each module can contain specialized scaffolding, templates, and tools for its particular purpose.
Provides complete scaffolding and workflow for creative writing projects. Includes:
- Project specification and planning structure
- Editorial workflow with revision phases
- Scene management and progress tracking
- Integration with Longform plugin for manuscript organization
- Dashboard views for tracking editorial progress
To create a new module first set up a new Apparatus Vault or navigate to an existing one, then see Installing Modules below.
Warning
The module system relies heavily on Git submodules. If unfamiliar with submodules, see the Git submodules documentation.
-
Navigate to https://github.com/lvnacy-notes/apparatus-vault-template.git and use the template to generate a new repository
-
Clone the repository:
git clone https://github.com/[your-username]/[your-apparatus-vault-name].git cd [your-apparatus-vault-name] -
Open the vault in Obsidian
-
Enable community plugins in settings
-
Customize theme and plugin settings as needed
To add a module to your vault:
- Navigate to https://github.com/lvnacy-notes/apparatus-module.git and use the template to generate a new repository
- Run the following command to add your new module to your Apparatus vault:
git submodule add git@github.com:[you-username]/[your-module-name].git-
Generate scaffolding from a module:
A. Ensure the module README is open in your editor
B. Use the Templater command palette
C. SelectTemplater: Open insert template modal
D. Choose the desired scaffold template
Update all submodules to their latest versions:
git submodule update --remoteClone with all submodules initialized:
git clone --recurse-submodules https://github.com/lvnacy-notes/apparatus-vault-template.git- Create a new
.cssfile in.obsidian/snippets/ - Include proper attribution headers with name, description, version, and author
- Enable in Obsidian settings under Appearance > CSS snippets
- Document the snippet in your plugin reference materials
- Navigate to
.obsidian/js/or your scripts directory - Edit JavaScript files as needed
- Test changes in your vault
- Commit and push changes to the scripts submodule repository
- Update the main vault's submodule reference
- Obsidian Documentation
- Codescript Toolkit Documentation
- Included plugin reference materials in
obsidian tooling reference/
The LVNACY Apparatus is released under the MIT License. See individual modules and components for specific attribution and licensing information.
Included CSS snippets are used with proper attribution to their original authors from the Obsidian community.