Home Original page

GitHub - unraid/docs: Unraid Documentation

Contributors Forks Stargazers Issues Docs Status Crowdin


Unraid Logo

Unraid Documentation

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Unraid Docs Screenshot

This repository powers the public Unraid Docs site. It contains source content, UI components, and supporting scripts that help the Unraid team publish accurate, localized, and accessible documentation for Unraid OS and connected services.

The documentation site is built on Docusaurus 3, rendered as a static site, and deployed via GitHub Pages. Remark-based linting, Crowdin integrations, and automated formatting scripts keep Markdown/MDX contributions consistent across the project.

(back to top)

Built With

  • Docusaurus
  • React
  • TypeScript
  • Remark
  • Vitest

(back to top)

Getting Started

Follow these steps to work on the docs locally.

Prerequisites

  • Node.js 22 or newer (see the package.json engines field)
  • pnpm via Corepack
  • Recommended: nvm for managing Node versions

Install or update Node with nvm:

nvm install --lts
nvm use

Installation

  1. Clone the repo

    git clone https://github.com/unraid/docs.git
cd docs

  2. Install dependencies

    corepack enable
pnpm install

(back to top)

Usage

Spin up a local Docusaurus dev server:

The local docs dev server listens on http://localhost:3001 by default. This keeps local iframe/embed testing aligned with iframe-test.html and other localhost examples in the repo.

Preview specific locales (one at a time):

pnpm start -- --locale zh
pnpm start -- --locale es

Run Docusaurus lint/build checks:

Additional project scripts:

  • Type check TypeScript: pnpm typecheck
  • Unit tests (watch): pnpm test
  • Single test run (CI): pnpm test:run
  • Build production site: pnpm build
  • Preview production build: pnpm serve

(back to top)

Contributing

New to the docs? Start with the contributor Style Guide for voice, formatting, and workflow expectations. It covers terminology, MDX conventions, screenshots, and review tips.

Once you're comfortable with the guidelines, typical workflow looks like:

  1. Fork the project
  2. Create a feature branch (git checkout -b docs/your-change)
  3. Run pnpm lint before committing
  4. Commit with a clear message (git commit -m "docs: describe change")
  5. Push to your fork and open a pull request against main

(back to top)

Top contributors

Contributor graph

Localization

Help translate Unraid Docs for the global community.

  • Join the project on Crowdin: unraid.crowdin.com/unraid-docs
  • Follow the glossary and tone guidance in the Style Guide
  • Run Crowdin exports/imports through the standard Crowdin workflow (no local MDX formatting pass is required)

Crowdin suggestions are reviewed regularly by maintainers and native-language contributors.

(back to top)

License

© 2024 Lime Technology, Inc. All rights reserved. See the Unraid Legal Terms for usage guidelines.

(back to top)

Contact

Need help? Open an issue on GitHub or reach us via unraid.net/contact.

Project Link: https://github.com/unraid/docs

(back to top)

Acknowledgments

(back to top)