Initial MkDocs template for GitHub Pages deployment

Add complete documentation template with Material theme, GitHub Actions workflow for auto-deploy, Python/MkDocs .gitignore, and guides for setup, configuration, customization, and contribution. Includes best practices and pre-configured features for rapid publishing.

Author: leandromonaco

.github/workflows/deploy.yml

@@ -0,0 +1,64 @@
+# GitHub Actions workflow for deploying MkDocs to GitHub Pages
+# This workflow runs automatically when you push to the main branch
+
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Install dependencies
+        run: pip install -r requirements.txt
+
+      - name: Build MkDocs site
+        run: mkdocs build --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,28 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Virtual environments
+venv/
+env/
+.venv/
+
+# MkDocs build output
+site/
+
+# IDE settings
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Local environment files
+.env
+.env.local
+/.vs

README.md

@@ -0,0 +1,92 @@
+# MkDocs Documentation Template
+
+A user-friendly template for publishing Markdown documentation to GitHub Pages using MkDocs with the Material theme.
+
+## 🚀 Quick Start
+
+### Option 1: Deploy to GitHub Pages (No local setup required)
+
+1. **Enable GitHub Pages**:
+   - Go to repository **Settings** → **Pages**
+   - Set **Source** to **GitHub Actions**
+
+2. **Push to main branch**:
+   ```bash
+   git add .
+   git commit -m "Initial documentation"
+   git push origin main
+   ```
+
+3. **View your site** at: `https://softwareworkercom.github.io/docs/`
+
+### Option 2: Local Development
+
+1. **Install dependencies**:
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # Windows: venv\Scripts\activate
+   pip install -r requirements.txt
+   ```
+
+2. **Start local server**:
+   ```bash
+   mkdocs serve
+   ```
+
+3. **Open** `http://127.0.0.1:8000` in your browser
+
+## 📁 Project Structure
+
+```
+docs/
+├── .github/
+│   └── workflows/
+│       └── deploy.yml      # GitHub Actions workflow
+├── docs/                   # Documentation content
+│   ├── index.md           # Home page
+│   ├── getting-started/   # Getting started guides
+│   ├── user-guide/        # User documentation
+│   └── contributing.md    # Contribution guidelines
+├── mkdocs.yml             # MkDocs configuration
+├── requirements.txt       # Python dependencies
+└── README.md              # This file
+```
+
+## ✨ Features
+
+- **Material Design theme** with dark/light mode toggle
+- **Automatic deployment** via GitHub Actions
+- **Full-text search** for all documentation
+- **Code highlighting** with copy button
+- **Responsive design** for mobile devices
+- **Edit on GitHub** links for easy contributions
+
+## 📝 Writing Documentation
+
+Add new pages by:
+
+1. Creating a `.md` file in the `docs/` folder
+2. Adding it to the `nav` section in `mkdocs.yml`
+
+See the [Writing Content](https://softwareworkercom.github.io/docs/user-guide/writing-content/) guide for Markdown tips.
+
+## ⚙️ Configuration
+
+Edit `mkdocs.yml` to customize:
+
+- Site name and description
+- Color scheme
+- Navigation structure
+- Enabled features
+
+## 📚 Documentation
+
+Visit the [documentation site](https://softwareworkercom.github.io/docs/) for detailed guides:
+
+- [Quick Start Guide](https://softwareworkercom.github.io/docs/getting-started/quickstart/)
+- [Installation Guide](https://softwareworkercom.github.io/docs/getting-started/installation/)
+- [Configuration Guide](https://softwareworkercom.github.io/docs/getting-started/configuration/)
+
+## 📄 License
+
+This project is open source and available under the [MIT License](LICENSE).

docs/contributing.md

@@ -0,0 +1,131 @@
+# Contributing
+
+Thank you for your interest in contributing to this documentation! This guide will help you get started.
+
+## Ways to Contribute
+
+### 🐛 Report Issues
+
+Found an error or have a suggestion?
+
+1. Go to the [Issues](https://github.com/softwareworkercom/docs/issues) page
+2. Click **New Issue**
+3. Describe the problem or suggestion clearly
+
+### ✏️ Edit on GitHub
+
+The quickest way to fix typos or small errors:
+
+1. Click the **pencil icon** (✏️) at the top of any page
+2. Make your changes in the GitHub editor
+3. Submit a pull request
+
+### 💻 Local Development
+
+For larger contributions:
+
+1. Fork the repository
+2. Clone your fork locally
+3. Create a new branch
+4. Make your changes
+5. Test locally with `mkdocs serve`
+6. Submit a pull request
+
+---
+
+## Setting Up Local Development
+
+### Prerequisites
+
+- Python 3.8 or higher
+- Git
+
+### Steps
+
+```bash
+# Clone your fork
+git clone https://github.com/YOUR-USERNAME/docs.git
+cd docs
+
+# Create virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Start local server
+mkdocs serve
+```
+
+Visit `http://127.0.0.1:8000` to preview your changes.
+
+---
+
+## Content Guidelines
+
+### Writing Style
+
+- **Be clear and concise** - Avoid jargon when possible
+- **Use active voice** - "Click the button" not "The button should be clicked"
+- **Address the reader directly** - Use "you" instead of "the user"
+- **Include examples** - Show, don't just tell
+
+### Formatting Standards
+
+- Use **sentence case** for headings: "Getting started" not "Getting Started"
+- Use **backticks** for code: `code here`
+- Use **bold** for UI elements: Click **Save**
+- Use **numbered lists** for sequential steps
+- Use **bullet points** for non-sequential items
+
+### Code Examples
+
+- Always specify the language for code blocks
+- Include comments to explain complex code
+- Test all code examples before submitting
+
+````markdown
+```python
+# Good: Includes language and comments
+def greet(name):
+    """Return a greeting message."""
+    return f"Hello, {name}!"
+```
+````
+
+---
+
+## Pull Request Process
+
+1. **Create a branch** with a descriptive name:
+   ```bash
+   git checkout -b fix/typo-in-quickstart
+   git checkout -b feature/add-api-docs
+   ```
+
+2. **Make your changes** and commit with clear messages:
+   ```bash
+   git commit -m "Fix typo in quickstart guide"
+   git commit -m "Add API reference documentation"
+   ```
+
+3. **Push to your fork**:
+   ```bash
+   git push origin your-branch-name
+   ```
+
+4. **Open a pull request** from your fork to the main repository
+
+5. **Wait for review** - Maintainers will review and provide feedback
+
+---
+
+## Questions?
+
+If you have questions about contributing, please:
+
+1. Check existing [Issues](https://github.com/softwareworkercom/docs/issues) for answers
+2. Open a new issue if your question isn't addressed
+
+Thank you for helping improve this documentation! 🙏