Skip to main content

Frequently Asked Questions (FAQ)

6 min readStableBeginner

Answers to the questions people ask most before adopting OwnDocs, plus a factual look at how it compares to the alternatives.

Product and Positioning

OwnDocs turns a folder of Markdown files into a documentation website, with search, sidebar navigation, and password protection already wired up. It runs on Next.js 16, React 19, and TypeScript 6. Teams use it for an external API reference, an internal knowledge base, or customer-facing product guides. The Introduction has the full picture.

Hosted platforms run the infrastructure for you, but they charge per seat and limit what you can change. OwnDocs ships as source code you own: a one-time purchase under the MIT license, with no per-seat fees, no monthly subscriptions, and no vendor lock-in. You deploy it on Vercel, AWS, DigitalOcean, or your own server, and you can change any part of it. See the comparison below for the specifics.

Three differences you can check rather than take on trust. Twenty-five documentation components ship ready to use, so the component library is not homework. One environment variable switches the whole site between open and password-protected. And AI readiness is built in, through llms.txt endpoints and a "Copy page as Markdown" button on every page. The reasoning behind those choices is in Why OwnDocs.

Comparing OwnDocs to Other Documentation Tools

The honest answer depends on what you're comparing OwnDocs to. Hosted SaaS platforms and free open-source generators solve the problem in opposite ways, and OwnDocs sits in a different spot from both. The tables below use each vendor's own current pricing and documentation pages, checked August 16, 2026. Vendor pricing changes, so confirm current numbers on their sites before you decide.

Against hosted, subscription-based platforms

Mintlify, GitBook, and ReadMe run your documentation site on their infrastructure and bill you for it every month. That gets you a working site fast, but the platform, not you, controls the code your site runs on, and the bill doesn't stop.

OwnDocs vs. hosted documentation platforms

FeatureRecommendedOwnDocsMintlifyGitBookReadMe
Pricing modelOne-time purchaseSubscription, per workspaceSubscription, per site + per seatSubscription, per admin seat
Free tier availablen/a: one-time purchaseIncludedIncludedIncludedIncludedIncludedIncluded
Self-hostedIncludedIncludedEnterprise plan only, frontend onlyFrontend only (GPL-3.0); content still lives on GitBookNot availableNot available
You own the platform source codeIncludedIncludedNot availableNot availablePartialPartialNot availableNot available
Every editor pays a per-seat feecross: no seats, everIncludedIncludedIncludedIncludedIncludedIncluded

Start with what each one charges.

GitBook's pricing page lists Premium at $65 per site per month and Ultimate at $249 per site per month, both billed annually, plus $12 per user per month on top. Every editor needs a paid seat even if they only ever read.

ReadMe lists a free Starter plan capped at one project and one admin, a $250-per-month Pro plan billed annually with five admins included, and Enterprise pricing starting around $3,000 per month.

Mintlify's Starter plan is free for up to five editor seats and has no AI features. Its Pro plan sits above that, and the page does not render a fixed figure, so check mintlify.com/pricing for the current number.

Self-hosting is where the three differ most. Mintlify offers it on Enterprise only, and only for a custom frontend, because its own content engine still runs behind the scenes. GitBook publishes an open-source frontend under GPL-3.0 that you can run yourself, but it renders content that still lives on GitBook's platform, and a private repository needs a separate commercial license. ReadMe publishes no self-hosted option outside custom Enterprise contracts.

Against free, open-source static site generators

Docusaurus and Nextra are genuinely free, MIT-licensed, and self-hosted. Against these two, OwnDocs isn't cheaper and doesn't offer anything unique about owning your source code. The real difference is how much of the site you have to build yourself before it's ready to publish.

OwnDocs vs. free, open-source generators

FeatureRecommendedOwnDocsDocusaurusNextra
CostOne-time purchaseFreeFree
LicenseMITMITMIT
Documentation components included25 components, ready to useBase set via the classic preset; deep branding means "swizzling" components that can break on minor upgradesCallout, Cards, Steps, Tabs, and FileTree ship with the theme; layout and navigation are wired by hand
Search included by defaultIncludedIncludedcross: needs Algolia DocSearch (eligibility required) or a self-run Algolia indexcross: needs a manual Pagefind install and build step
Built-in version switchingIncludedIncludedIncludedIncludedNot availableNot available
Sidebar, search index, and breadcrumbs auto-generated from filesIncludedIncludedpartial: sidebar config is manualIncludedIncluded

Docusaurus is Meta-backed, has native versioning, and carries a large plugin ecosystem. Those are real strengths. Its own docs describe theme customization through "swizzling," and warn that swizzled components "may change in a backward-incompatible way between theme minor versions." Search is not built in either: Algolia's free DocSearch program has eligibility requirements, and a site that does not qualify has to run its own Algolia index.

Nextra is the closer sibling. It is also built on Next.js and its theme ships a real set of components. But its start guide has you installing packages, writing next.config.mjs, and wiring a root layout by hand, and its search guide has you adding Pagefind as a separate dependency with your own postbuild step. Nextra has no built-in version switching.

OwnDocs gives you the same source ownership as either one, with the component library, the generated sidebar, search, and the version switcher already wired together. The tradeoff is plain: OwnDocs is a paid product and these two are free.

Content and Authoring

Pages come from files, with no configuration. Create an .mdx file and write. OwnDocs builds the sidebar, search index, breadcrumbs, table of contents, sitemap, and static pages for you. There's no routing config or build plugin to set up, and the file path is the URL. Content lives in version control next to the code it documents, so it gets the same review, diff, and rollback workflow as everything else in the repository, instead of living in a separate database your engineers can't git blame.

No. Create any .mdx file under content/ and it becomes a page. For example, content/guides/deployment.mdx becomes /guides/deployment. Directories become sidebar categories, and OwnDocs wires the new file into the sidebar, the search index, the sitemap, and the previous/next links automatically.

Ownership, Licensing, and Deployment

Yes. OwnDocs is a one-time purchase under the MIT license. There are no per-seat fees, no monthly subscriptions, and no vendor lock-in: you can modify, redistribute, and deploy it under the terms of that license.

Anywhere that runs Next.js: Vercel, AWS, DigitalOcean, or your own server. See Deployment for the specific steps for each target.

Access, Security, and AI

Yes. A single ACCESS_MODE environment variable switches the whole site between private (password-protected) and public (open) access. It defaults to public, so a fresh install runs without any password setup; set ACCESS_MODE="private" and the three secrets in .env.local when you want a password wall. One deployment can serve internal team docs, client portals, or public product docs: you don't need separate installs for each.

Private mode uses JWT sessions with browser fingerprinting (a session is invalidated if the User-Agent or Accept-Language header changes), secure __Host- prefixed cookies, a salted and hashed cookie name, rate limiting on login attempts, and 4-layer crawler blocking so search engines and AI crawlers can't index protected pages. See the Introduction for the full list.

Yes. OwnDocs generates an llms.txt index and an llms-full.txt file with the full documentation content, both built for AI agents to consume in bulk. Every page also has a "Copy page as Markdown" button next to its title, so a reader can paste a page straight into ChatGPT, Claude, or Cursor.

See also

  • Installation: extract the archive and install dependencies with npm, Bun, or pnpm.
  • Configuration: every environment variable and config file, with its default.
  • Deployment: push your copy to your own repository, then deploy it to a host or run it in Docker.
Was this page helpful?

© 2026 DevOps. All rights reserved.