mirror of
https://github.com/yeban8090/book-smith.git
synced 2026-07-22 05:46:23 +00:00
No description
| src | ||
| .gitignore | ||
| build.sh | ||
| esbuild.config.mjs | ||
| LICENSE | ||
| manifest.json | ||
| package-lock.json | ||
| package.json | ||
| README.en.md | ||
| README.md | ||
| tsconfig.json | ||
Book Smith
Book Smith is a writing management plugin designed for Obsidian, helping authors better organize and manage their writing projects.
简体中文 | English
功能演示
Features
- 📚 Book Project Management
- Create and manage multiple book projects
- Support custom book templates
- Custom cover images
- Basic information management
- 📑 Chapter Management
- Tree structure display
- Drag-and-drop sorting
- Chapter status marking
- Flexible folder organization
- 📊 Writing Statistics
- Real-time word count
- Writing progress tracking
- Daily writing volume statistics
- Goal completion analysis
- 🎯 Focus Writing
- Pomodoro technique
- Customizable work/break duration
- Writing data tracking
- Interruption statistics and analysis
- 📝 Reference Management
- Quick reference creation
- Automatic numbering system
- Bibliography generation
- Reference search
- 📤 Export: Support multiple formats
Usage
Basic Usage
- After installation, a book management icon will appear in the left sidebar
- Click "New Book" to create your first book
- In the book management interface, you can:
- Create/edit chapters
- Manage book information
- View writing statistics
Reference Management
- Select text to create new references
- Use right-click menu to manage references
- Automatically generate bibliography
- Quick search existing references
Focus Writing
- Click the focus mode icon to enter focus writing
- Set work duration and break time
- Start focused writing
- View writing data and progress
Installation
From Obsidian Community Plugins (Recommended)
- Open Obsidian Settings
- Go to Third-party Plugins
- Disable Safe Mode
- Click Browse Community Plugins
- Search for "Book Smith"
- Click Install and Enable
Manual Installation
- Download the latest release: https://github.com/Yeban8090/book-smith/releases
- Extract and copy the folder to Obsidian plugins directory:
{vault}/.obsidian/plugins/ - Restart Obsidian
- Enable the plugin in Settings
Configuration
Basic Settings
- Default author information
- Book storage path settings
Template Settings
- Default template selection
- Template management
- Custom templates
- Template structure
- Template description
Focus Mode Settings
- Work duration adjustment
- Break time settings
- Notification preferences
- Statistics rules configuration
Tips
- Use templates to quickly create common book structures
- Regularly backup your book data
- Use statistics to set daily writing goals
- Use reference features to manage research materials
- Try different export formats for various publishing needs
- Use drag-and-drop to organize chapter structure
- Use chapter status markers to track progress
- Improve writing efficiency with focus mode
Cross-platform Support
- Full desktop support
- Optimized mobile experience
- Automatic data synchronization
- Consistent user experience
Supported Languages
The plugin interface currently supports:
- Simplified Chinese
- English
Support The Author
If this plugin helps you, consider buying me a coffee ☕:
Your support motivates me to keep improving this plugin!
License
MIT License. See LICENSE for more information.
Author
Yeban
Feedback and Support
If you encounter any issues or have suggestions, feel free to submit an issue on GitHub.