Christmas

An Obsidian plugin that brings Christmas spirit to your editor by showing the countdown to Christmas.

Features

• Days until Christmas Command 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 icon
• Statusbar visible time before Chistmas: Make the Christmas button show up on a specific time before Christmas
• Christmas day: The calendar day of Christmas at your location
• Christmas month: The calendar month of Christmas at your location

Manually installing the plugin

• Copy over main.js and manifest.json to your vault VaultFolder/.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

1. Create a new vault for your development
2. Fork and clone the repository to VaultFolder/.obsidian/plugins/Christmas/
3. Run npm install to install dependencies
4. Open the project in an IDE of your choice
5. Run npm run dev
6. Enable the community plugin
7. Start editing
8. Disable and enable the plugin again to see your changed

Development Workflow

1. Create a new branch for your feature/fix

   git checkout -b feature/your-feature-name
   

2. Make your changes and ensure they follow our coding standards

4. 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.