Wiki

What is Wiki?

Wiki provides a space for collaborative documentation within your repository. It's perfect for project documentation, guides, and knowledge bases.

Creating a Wiki

Enable Wiki

1. Go to Repository Settings
2. Under "Advanced Settings", ensure "Enable Wiki" is checked
3. Choose wiki visibility:
   • Public: Anyone can view
   • Private: Only collaborators can view

Create First Page

1. Navigate to Wiki tab
2. Click "Create first page"
3. Add:
   • Page title: Name of the page
   • Content: Write in Markdown
4. Click "Create"

Wiki Features

Markdown Support

Write using Markdown syntax:

# Header 1
## Header 2

**Bold text**
*Italic text*

- List item 1
- List item 2

[Link text](https://example.com)

![Image alt](image-url)

Multiple Pages

Create multiple pages for different topics:

• Home - Main wiki page
• Getting Started - Setup guide
• API Documentation - API reference
• Deployment - Deploy instructions

Page Organization

• Sidebar: Auto-generated from page titles
• Internal links: Link between wiki pages
• Revisions: Track changes and view history

Managing Wiki

Edit Pages

1. Click "Edit" button on any page
2. Make your changes
3. Add edit message (optional)
4. Click "Save"

Delete Pages

1. Click "Delete" button
2. Confirm deletion

⚠️ Warning: Deleted pages cannot be recovered!

Page History

View all revisions:

1. Click "Page History"
2. See list of all changes
3. Compare versions
4. Revert to previous version if needed

Best Practices

• ✅ Start with a comprehensive Home page
• ✅ Use clear, descriptive page titles
• ✅ Organize content logically
• ✅ Include code examples where relevant
• ✅ Keep documentation up-to-date
• ✅ Use internal links to connect related pages
• ✅ Add images and diagrams for clarity

Common Use Cases

Project Documentation

• Architecture overview
• Setup instructions
• Configuration guide
• API reference

Team Knowledge Base

• Coding standards
• Deployment procedures
• Troubleshooting guides
• Onboarding materials

User Guides

• Feature documentation
• Tutorials
• FAQ
• Examples

Wiki vs README

Next Steps

• Learn about Issues
• Explore Pull Requests
• Read about Organizations