Principle 0.1
File system
Your configuration and integration live in a directory in your repo. Just files and folders. You own it all.
PublishBeautifulContentBeautiful
An operating system to help you write and publish better content. Built on simple principles, publish.os creates fast, on-brand sites that humans & machines love reading.
An operating system to help you write and publish better content.
Built on simple principles, publish.os handles everything you haven’t thought of.
A fast, on-brand, human & machine readable site is the minimum result.
Foreword
You don’t have to choose between vibe-coding or a rigid CMS for your most important words.
With publish.os you own your code and content and get a fast, beautiful site.
How it works
a publish.os/ directory is the entire integration
acme.com/docs/install
Documentation Quick guide
Installation guide
Connect to Acme and make your first request in a few minutes. Start with an existing project or a fresh one.
Install the SDK
Add the SDK to your project. Run this command from the root of your repository.
Terminalnpm
npm install @acme/sdkConnect to Acme
Create an API key in your workspace and save it as an environment variable. Then follow the API reference to send your first request.
Server-side only
Keep your API key out of client code.
- Markdown becomes a published installation guide
- Your content is automatically published and kept in sync with your repo
- hosted on your domain
When you want more control or customization, simply author your own layouts, pages, or components.
acme.com/docs
Acme app
- Your page, your button, your theme & css
- Beautiful docs that feel exactly like your site or product
Principles & philosophy
Principles
Principle 0.2
Git
Version your docs alongside your code. Review changes, merge, and publish automatically, keeping your content in sync with your product.
Principle 0.3
Markdown
Write in plain text. Publish as beautiful, formatted components. Your content stays easy for people to write and agents to read.
Principle 0.4
Own your code & content
You own your words and how they’re shown. Start with a fast, beautiful site. Make it your own with custom layouts, pages, components, and CSS.
Results
Great for people. Easy for AI agents.
Performant, accessible, and agent ready.
Human & machine ready
- 100100 out of 100
Performance Lighthouse
- 100100 out of 100
Accessibility Lighthouse
- 100100 out of 100
Best practices Lighthouse
- 100100 out of 100
SEO Lighthouse
- 9898 out of 100
Agent-friendly docs AFDocs
- 9696 out of 100
Agent readiness IsAgentic
- 2/22 out of 2 checks passed
Agentic browsing Lighthouse
- FCP
- 0.4s
- LCP
- 0.5s
- TBT
- 0ms
- CLS
- 0
Build Anything
Docs, Blogs, Help Centers, API References, Changelogs, Guides, and anything else you can imagine.
In beta. Tell us what you want to build and we'll set up your site.