Skip to content

Quick Start Guide

Get your U.WIKI instance running in just a few minutes!

1. Clone the Repository

git clone https://github.com/yourusername/U.WIKI.git
cd U.WIKI

2. Create Virtual Environment

python -m venv venv
venv\Scripts\activate

python3 -m venv venv
source venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt

4. Start the Development Server

mkdocs serve

Your wiki will be available at http://localhost:8000

That's it!

You now have a fully functional wiki running locally!

5. Making Changes

  1. Edit Markdown files in the docs/ directory
  2. Save your changes - the site will auto-reload
  3. View updates in your browser instantly

Common Tasks

Adding a New Page

  1. Create a new .md file in the docs/ directory
  2. Add it to the nav section in mkdocs.yml
  3. The page will appear in the navigation

Changing the Theme

Edit mkdocs.yml and modify the theme section:

theme:
  palette:
    primary: indigo  # Change this
    accent: indigo   # And this

Building for Production

mkdocs build

This creates a site/ directory with static HTML files ready for deployment.

Next Steps