obswiki/wiki/examples/getting-started.md

Getting Started with ObsWiki

This guide will help you get up and running with ObsWiki quickly.

Creating Your First Page

1. Navigate to any non-existent page by typing the URL or clicking a broken link
2. You'll see a "Create it now" button
3. Click it to start editing your new page

Wiki Syntax

Links Between Pages

Create links to other pages using double square brackets:

• [[Page Name]] creates a link to "Page Name"
• [[Custom Display Text|Actual Page Name]] for custom link text

Tags

Organize your content with hashtags:

• #project - Single tags
• #meeting-notes - Multi-word tags
• #important #urgent - Multiple tags

Frontmatter

Add metadata to your pages:

---
title: "My Important Document"
author: "John Doe"
created: "2024-01-15"
tags: "documentation, important"
---

File Organization

ObsWiki follows a simple file structure:

wiki/
├── index.md                 # Home page
├── projects/
│   ├── project-alpha.md
│   └── project-beta.md
├── meetings/
│   ├── 2024-01-15-standup.md
│   └── 2024-01-16-planning.md
└── personal/
    └── my-notes.md

Search and Navigation

• Global Search: Use the search bar to find content across all pages
• Tag Search: Search for #tagname to find all pages with that tag
• Backlinks: See which pages link to the current page in the sidebar

Collaboration

User Roles

• Viewer: Can read pages they have access to
• Editor: Can create and edit pages
• Admin: Full control over users and access rules

Access Control

Pages can be restricted based on their path:

• admin/* - Admin-only pages
• private/* - Editor and admin access
• Everything else is accessible to viewers

Tips and Tricks

1. Start with an index: Create topic index pages that link to related content
2. Use consistent naming: Keep page names descriptive and consistent
3. Link liberally: Don't hesitate to create links - broken links show what needs to be created
4. Tag strategically: Use tags to create cross-cutting views of your content
5. Structure folders: Organize related pages in folders for better navigation

Advanced Features

Markdown Extensions

ObsWiki supports standard Markdown plus:

• Tables
• Code blocks with syntax highlighting
• Task lists (coming soon)
• Math expressions (coming soon)

API Access

All wiki content is available via REST API:

• GET /api/wiki/page-name - Get page JSON
• GET /api/search?q=query - Search API

Need Help?

• Check the FAQ for common questions
• See the User Guide for detailed documentation
• Create an issue on GitHub for bugs or feature requests

Happy writing! ✨