DokuWiki Documentation Format
This directory contains the homelab documentation formatted for DokuWiki. DokuWiki uses a different syntax than standard Markdown.
📁 File Structure
start.txt- Main documentation index pageservices-popular.txt- Popular services guideservices-individual-index.txt- NEW! Complete index of all 159 individual service docsgetting-started-quick-start.txt- Quick start guide
🔧 How to Use
Option 1: Copy Individual Files
- Copy the
.txtfiles to your DokuWikidata/pages/directory - Create appropriate subdirectories (e.g.,
services/,getting-started/) - Access via your DokuWiki web interface
Option 2: Bulk Import
-
Create the following directory structure in your DokuWiki:
data/pages/homelab/ ├── start.txt ├── services/ │ └── popular.txt ├── getting-started/ ├── infrastructure/ ├── admin/ ├── troubleshooting/ └── advanced/ -
Copy files to appropriate directories
-
Access at
http://your-dokuwiki/doku.php?id=homelab:start
🎨 DokuWiki Syntax Used
======for main headings=====for subheadings====for sub-subheadings^for table headers|for table cells[[namespace:page|Link Text]]for internal links<code>blocks for code examples//italic//and**bold**for emphasis
🔄 Converting from Markdown
Key differences from Markdown:
- Headers use
=instead of# - Tables use
^for headers and|for cells - Links use
[[]]syntax - Code blocks use
<code>tags - Lists use
*(two spaces + asterisk)
📝 Customization
You can customize these files for your DokuWiki installation:
- Update internal links to match your namespace structure
- Modify styling and formatting as needed
- Add your own branding or additional content
🔗 Related
- Main documentation:
../docs/ - Joplin format:
../joplin/ - Original repository structure:
../