- Dynamic Vault Display: Instantly view your current vault's name in the Obsidian status bar.
- Customizable Appearance: Personalize the display to match your workspace, ensuring a seamless integration.
- Vaults Menu: One-click access to the vaults menu for easy navigation.
- Enhanced Efficiency: This plugin provides the advantage of keeping this information always visible in the status bar, and providing another quick access to the vaults menu.
- Displays your current vault name in the status bar
- Click to open a menu for quick vault switching
- Customizable appearance
- Vaut name length customizable
- Color: Choose the color of the vault name in the status bar
- Font Size: Adjust the font size of the vault name (in em)
- Enable Maximum Length: Option to truncate the vault name if it exceeds the maximum length
- Maximum Length: Set the maximum number of characters to display in the vault name
- The vault name appears in the status bar
- Click on the vault name to open a menu with options to switch to other vaults or manage vaults
- The current vault is indicated with a checkmark in the menu
- copy files from the release
- install them in your vault/.obsidian/plugins/status_vault_bar or use Brat
If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository.
This project is licensed under the MIT License.
This plugin uses a template that automates the development and publication processes on GitHub, including releases. You can develop either inside or outside your Obsidian vault.
main.ts
andstyles.css
must be in thesrc
folder.- After building,
styles.css
will appear in the root folder (this is normal for the release process).
-
Inside the vault's plugins folder:
- Delete the
.env
file. - Run npm commands as usual.
- Delete the
-
Outside the vault:
- Set the paths in the
.env
file:TestVault
for developmentRealVault
for production simulation
- Necessary files will be automatically copied to the targeted vault.
- Set the paths in the
npm run start
: Opens VS Code, runsnpm install
, thennpm run dev
npm run dev
: For developmentnpm run build
: Builds the projectnpm run real
: Simulates a traditional plugin installation in your REAL vaultnpm run bacp
: Builds, adds, commits, and pushes (prompts for commit message)npm run acp
: Adds, commits, and pushes (without building)npm run version
: Updates version, modifies relevant files, then adds, commits, and pushesnpm run release
: Creates a GitHub release (prompts for release title, can be multiline using\n
)
npm run start
npm run bacp
npm run version
npm run release
- obsidian-typings: This template automatically includes obsidian-typings, providing access to additional types not present in the official API.