This commit is contained in:
2025-08-10 10:31:10 -04:00
commit db767dcabc
26 changed files with 8170 additions and 0 deletions

View File

@@ -0,0 +1 @@
sdfasl;kdjf;laskdjf ;lkasjdf;lk asj;lf kj

View File

@@ -0,0 +1,109 @@
# 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:
```yaml
---
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! ✨

81
wiki/index.md Normal file
View File

@@ -0,0 +1,81 @@
---
title: "Welcome to ObsWiki"
author: "ObsWiki"
tags: "welcome, getting-started"
---
# Welcome to ObsWiki
Welcome to your new Obsidian-style wiki! This is your home page where you can start building your knowledge base.
## Getting Started
ObsWiki supports all the markdown features you love from Obsidian:
- **Wiki links**: Create links to other pages using `[[Page Name]]`
- **Tags**: Organize content with tags like #documentation #wiki
- **Frontmatter**: Add metadata to your pages (like this page!)
## Features
### Wiki Links
You can create links to other pages easily:
- [[Getting Started]] - Learn the basics
- [[User Guide]] - Comprehensive guide
- [[FAQ]] - Frequently asked questions
### Tags
Use tags to categorize your content: #important #reference #tutorial
### Code and Syntax
```rust
fn main() {
println!("Hello, ObsWiki!");
}
```
### Lists and Organization
- **Project Management**
- Planning docs
- Meeting notes
- Status updates
- **Technical Documentation**
- API references
- Deployment guides
- Architecture decisions
- **Personal Notes**
- Daily logs
- Ideas and thoughts
- Reading lists
## Authentication
ObsWiki supports multiple authentication methods:
- Local username/password accounts
- GitHub OAuth integration
- Google OAuth (configurable)
- LDAP integration (configurable)
## Access Control
Different areas of your wiki can have different access levels:
- Public pages (accessible to all users)
- Private pages (restricted by role)
- Admin sections (admin-only access)
## Next Steps
1. **Customize your wiki**: Edit this page and create new ones
2. **Set up authentication**: Configure OAuth providers if needed
3. **Organize content**: Create folder structures and use tags
4. **Invite users**: Add team members with appropriate roles
Happy wiki building! 🚀
---
*This page is editable by administrators and editors. [[Edit This Page]]*

24
wiki/projects.md Normal file
View File

@@ -0,0 +1,24 @@
# Projects
This is a collection of my various projects.
## Active Projects
### [[Web Development]]
Working on modern web applications using React and TypeScript.
### [[Data Science]]
Analyzing data with Python and machine learning libraries.
## Completed Projects
- **ObsWiki**: A wiki system built with Rust #rust #web #wiki
- **Task Manager**: Personal productivity app #productivity #app
## Future Ideas
- [ ] Mobile app development
- [ ] IoT home automation
- [ ] Machine learning experiments
Back to [[index]]