README file from
GithubChristmas
An Obsidian plugin that brings Christmas spirit to your editor by showing the countdown to Christmas.
Features
Days until ChristmasCommand to check the countdown- Status bar button showing days until Christmas
Extension Settings
This extension has the following settings:
Toggle large statusbar text: Toggle the text beside the icon for the status bar iconStatusbar visible time before Chistmas: Make the Christmas button show up on a specific time before ChristmasChristmas day: The calendar day of Christmas at your locationChristmas month: The calendar month of Christmas at your location
Manually installing the plugin
- Copy over
main.jsandmanifest.jsonto your vaultVaultFolder/.obsidian/plugins/Christmas/.
Community Feedback and Ideas
We value input from our users! Help make Obsidian-Christmas even more festive:
Share Your Ideas
- Have an idea for a new feature?
- Want to suggest holiday-themed customizations?
- Think of ways to make the extension more fun or useful?
Please open a GitHub Discussion or create an issue tagged with "enhancement". Some areas we'd love feedback on:
- Visual customization options
- Additional holiday-related commands
- Integration with other Obsidian features
- Accessibility improvements
Your feedback helps improve the extension and guides our development priorities!
Contributing
We welcome contributions from the community! Here's how you can help:
Setting up the Development Environment
- Create a new vault for your development
- Fork and clone the repository to
VaultFolder/.obsidian/plugins/Christmas/ - Run
npm installto install dependencies - Open the project in an IDE of your choice
- Run
npm run dev - Enable the community plugin
- Start editing
- Disable and enable the plugin again to see your changed
Development Workflow
-
Create a new branch for your feature/fix
git checkout -b feature/your-feature-name -
Make your changes and ensure they follow our coding standards
- Submit a Pull Request:
- Write a clear description of your changes
- Reference any related issues
Coding Guidelines
- Follow the existing code style
- Add comments for complex logic
- Keep commits focused and descriptive
Reporting Issues
- Use the GitHub issue tracker
- Include Obsidian version and extension version
- Provide clear steps to reproduce the issue
- Include relevant error messages and screenshots
Release Notes
Please see the CHANGELOG.md file for detailed release notes.
License
This project is licensed under the MIT License - see the LICENSE file for details.