107 lines
3.6 KiB
Markdown
107 lines
3.6 KiB
Markdown
# Joplin Documentation Format
|
|
|
|
This directory contains the homelab documentation formatted specifically for Joplin note-taking application. The files are organized with numbered prefixes for easy sorting and navigation.
|
|
|
|
## 📁 File Structure
|
|
|
|
Files are numbered for logical organization in Joplin:
|
|
|
|
- **00-09**: Index and overview documents
|
|
- `00-Homelab-Documentation-Index.md` - Main index
|
|
- **10-19**: Infrastructure and architecture
|
|
- `19-Individual-Service-Docs.md` - **NEW!** Complete index of all 159 individual service docs
|
|
- **20-29**: Services and applications
|
|
- `22-Popular-Services.md` - Popular services guide
|
|
- **30-39**: Administration and deployment
|
|
- **40-49**: Troubleshooting and maintenance
|
|
- **50-59**: Advanced topics and automation
|
|
|
|
## 🔧 How to Import into Joplin
|
|
|
|
### Option 1: Individual File Import
|
|
1. Open Joplin
|
|
2. Create a new notebook called "Homelab Documentation"
|
|
3. For each `.md` file:
|
|
- File → Import → Markdown files
|
|
- Select the file
|
|
- Import into the Homelab Documentation notebook
|
|
|
|
### Option 2: Bulk Import
|
|
1. Open Joplin
|
|
2. File → Import → Markdown files
|
|
3. Select all `.md` files in this directory
|
|
4. Choose "Homelab Documentation" as the destination notebook
|
|
|
|
### Option 3: Folder Import
|
|
1. Copy this entire `joplin/` directory to a temporary location
|
|
2. In Joplin: File → Import → Markdown files
|
|
3. Select the directory
|
|
4. All files will be imported with proper organization
|
|
|
|
## 🎨 Joplin-Specific Features
|
|
|
|
These files are optimized for Joplin with:
|
|
|
|
- **Numbered prefixes**: For automatic sorting
|
|
- **Cross-references**: Links between related documents
|
|
- **Table of contents**: In the main index file
|
|
- **Consistent formatting**: Standard Markdown with Joplin compatibility
|
|
- **Emoji icons**: For visual organization and quick identification
|
|
|
|
## 📱 Mobile Compatibility
|
|
|
|
These files work well on Joplin mobile apps:
|
|
- Tables are formatted for mobile viewing
|
|
- Code blocks are properly formatted
|
|
- Links work across devices
|
|
- Images and diagrams are optimized
|
|
|
|
## 🔍 Search and Organization
|
|
|
|
In Joplin, you can:
|
|
- **Search across all documents**: Use Joplin's full-text search
|
|
- **Tag documents**: Add tags like `#homelab`, `#docker`, `#beginner`
|
|
- **Create shortcuts**: Pin frequently accessed documents
|
|
- **Use notebooks**: Organize by topic or skill level
|
|
|
|
## 🔄 Keeping Updated
|
|
|
|
To update the documentation:
|
|
1. Replace the files in your Joplin notebook
|
|
2. Or re-import the updated files
|
|
3. Joplin will preserve your notes and annotations
|
|
|
|
## 📝 Customization
|
|
|
|
You can customize these files in Joplin:
|
|
- Add your own notes and annotations
|
|
- Create additional cross-references
|
|
- Add tags for better organization
|
|
- Modify formatting to your preferences
|
|
|
|
## 💡 Tips for Using in Joplin
|
|
|
|
1. **Create a dedicated notebook**: Keep all homelab docs together
|
|
2. **Use tags**: Tag documents by difficulty level or topic
|
|
3. **Pin important docs**: Pin the index and frequently used guides
|
|
4. **Enable synchronization**: Sync across all your devices
|
|
5. **Use the web clipper**: Add related articles and resources
|
|
|
|
## 🔗 Related
|
|
|
|
- Main documentation: `../docs/`
|
|
- DokuWiki format: `../dokuwiki/`
|
|
- Original repository structure: `../`
|
|
|
|
## 📋 Document Numbering System
|
|
|
|
- **00-09**: Overview and getting started
|
|
- **10-19**: Infrastructure and architecture
|
|
- **20-29**: Services and applications
|
|
- **30-39**: Administration and deployment
|
|
- **40-49**: Troubleshooting and maintenance
|
|
- **50-59**: Advanced topics and automation
|
|
- **60-69**: Reference materials (future use)
|
|
- **70-79**: Templates and examples (future use)
|
|
- **80-89**: Community and resources (future use)
|
|
- **90-99**: Appendices and extras (future use) |