/omarchy-hub

A comprehensive resource library for Omarchy Linux

Primary LanguageTypeScriptMIT LicenseMIT

Omarchy Hub

A community-driven website for collecting and sharing themes, setups, resources, and links for Omarchy - the opinionated Arch + Hyprland setup by DHH.

🌐 Live Website: https://omarchy.deepakness.com

Netlify Status License

Project Structure

├── app/                    # Next.js App Router pages
│   ├── page.tsx            # Homepage with featured content
│   ├── themes/page.tsx     # Themes listing page
│   ├── setups/page.tsx     # Setups listing page
│   └── resources/page.tsx  # Resources listing page
├── components/             # Reusable React components
│   ├── Card.tsx            # Content card component
│   ├── OmarchyLogo.tsx     # Main logo component
│   ├── PixelButton.tsx     # Retro-style button component
│   ├── Header.tsx          # Navigation header
│   └── Breadcrumb.tsx      # Navigation breadcrumb
├── data/                   # JSON data files
│   ├── themes.json         # Themes data
│   ├── setups.json         # Setups data
│   ├── resources.json      # Resources data
│   ├── releases.json       # Omarchy releases, scrapes automatically
│   └── links.json          # Links data
├── public/                 # Static assets
│   └── setups/             # Setup screenshots
└── .github/                # GitHub templates and workflows
    ├── ISSUE_TEMPLATE/     # Issue templates for contributions
    └── pull_request_template.md

Contributing Content

We welcome contributions from the community! There are several ways to contribute:

🚀 Quick Contribution (Recommended)

For Beginners: Use our GitHub issue templates for easy submission:

🔧 Developer Contribution

For Developers: Submit pull requests directly:

  1. Fork the repository
  2. Add your content to the appropriate JSON file in /data/
  3. Follow the data structure guidelines below
  4. Submit a pull request

📋 Data Structure Examples

Setups (data/setups.json):

{
  "id": "unique-id",
  "name": "Setup Name",
  "description": "Brief one-line description of your setup",
  "screenshot": "setups/setup-image.jpg",
  "link": "https://social-post-url.com",
  "device": "Hardware details",
  "category": "Desktop",
  "tags": ["tag1", "tag2"]
}

Themes (data/themes.json):

{
  "id": "unique-id",
  "name": "Theme Name",
  "category": "Dark Theme | Light Theme",
  "link": "https://github.com/username/theme",
  "author": "Author Name",
  "screenshot": "https://screenshot-url.com",
  "tags": ["official", "popular"]
}

Resources (data/resources.json):

{
  "id": "unique-id",
  "name": "Resource Name",
  "description": "Brief one-line description of the resource",
  "category": "Documentation | Article | Discussion | Video | Tool",
  "link": "https://resource-url.com",
  "author": "Author Name",
  "tags": ["guide", "tutorial"]
}

Links (data/links.json):

{
  "name": "Link Name",
  "url": "https://link-url.com"
}

📖 Detailed Guidelines

For complete contribution guidelines, see CONTRIBUTING.md.

Community

Acknowledgments

  • DHH for creating Omarchy
  • The Arch Linux and Hyprland communities for their amazing work
  • All contributors who share their setups, themes, and resources

License

This project is open source and available under the MIT License.