signcodify
Start free

Documentation your team keeps up to date.

Signcodify is a docs platform for software teams. Write in a block editor, sync with Git, and publish a fast docs site with an API reference and AI search.

Start freeSee the editor

Editor / welcome.md

H2

Welcome to Lumen Pay

Text

Take card payments with one API call. This guide gets you to your first payment.

Or tap:

docs.lumenpay.com/welcome

Published

Docs / Getting started

Welcome to Lumen Pay

Take card payments with one API call. This guide gets you to your first payment.

Try it: type a sentence and press Enter, or type / and pick a block. The page on the right updates as you write.

Quickstart

Three steps from sign-up to a published docs site. Most teams finish them in one sitting.

  1. 1

    Create a space

    A space is one docs site: product docs, an API reference or an internal wiki. Name it and pick who can see it.

  2. 2

    Write, or bring what you have

    Start in the editor, or connect a GitHub or GitLab repository and Signcodify imports your Markdown and keeps it in sync.

  3. 3

    Publish

    Your docs go live on a signcodify.com address right away. Add docs.yourco.com when you are ready.

Note. Already keep docs as Markdown in a repo? Point Signcodify at the folder. Your files stay the source of truth, and edits made in Signcodify come back as pull requests.

Or start from your terminal

npx signcodify init
# pick a space name, then:
npx signcodify push ./docs

Who it is for

SaaS teams with an API

Keep the reference in step with the OpenAPI file and let developers try requests from the page.

Startups

One place for product docs, the help center and the internal wiki, set up in an afternoon.

Platform and DevRel teams

Guides, versions and a changelog for every service, with roles so each team owns its pages.

Open source projects

Docs that live in the repo, take contributions as pull requests and publish on every merge.

Signcodify is made by a small team in New York.About Signcodify

Write in blocks

Press / to add a heading, a code block, a callout or tabs. Every page is Markdown underneath, so your docs are never locked in.

Slash commands

Type / anywhere to insert a block.

/

  • Heading/heading
  • Code block/code
  • Callout/callout
  • Tabs/tabs

Callouts

Note, Tip and Warning, so readers spot what matters.

Note. Keys are scoped to one project.

Warning. Rotating a key signs out every running job.

Code blocks

Syntax highlighting, line numbers and a copy button.

Copied
const client = new Lumen({ apiKey: process.env.LUMEN_KEY })
await client.payments.create({ amount: 2400 })

Tabs

One step, shown per language or per platform.

macOSLinuxWindows
brew install signcodifycurl -fsSL get.signcodify.com | sh
Tip. Paste a screenshot, a table from a spreadsheet or a code snippet. Signcodify turns each into the right block.

getting-started.md, as stored in your repo

## Install the SDK

> [!NOTE]
> Keys are scoped to one project.

```bash
npm install @lumen/pay
```

Versions and changelog

Keep docs for every supported version. Readers pick one from the switcher, and the changelog shows what moved between them.

Docs / Authentication

Authenticate requests

v2 uses bearer tokens. Keys start with lk_live_ or lk_test_.

curl https://api.lumenpay.com/v2/payments \
  -H "Authorization: Bearer $LUMEN_KEY"

Changelog

  1. v2.3Refunds can be partialAddedOct 21
  2. v2.2Webhook retries back off to 24 hoursChangedSep 30
  3. v2.0Bearer tokens replace the X-Api-Key headerBreakingAug 12

Each entry links to the pages it changed.

Sync with GitHub or GitLab

Connect a repository and Signcodify keeps both sides in step. Edits in the editor become pull requests, and merged changes publish on their own.

Editing: Docs / Rate limits

Edit the text to see the diff.

docs/rate-limits.md

Requests are limited to 100 per minute for each API key.
Note. Signcodify only asks for access to the repositories you pick. Branch protection and required reviews keep working as they do today.

Publish on your own domain

Every space gets a signcodify.com address. Add your own domain, your colour and a dark mode for readers, and Signcodify handles the certificate.

Point a CNAME at cname.signcodify.com. HTTPS is set up for you.

Brand colour
Dark mode preview
https://docs.yourco.com/quickstart

Quickstart

Create a key in Settings, then send your first request.

Get an API key
curl https://api.yourco.com/v1/ping

Roles and private pages

Keep the internal wiki and unreleased features behind sign-in. Public and private pages can live in the same space.

Owner

Billing, domains, everything

Admin

Spaces, members, Git settings

Editor

Write and publish pages

Viewer

Read private pages

Private pages never show up in search engines or in public AI answers.

An API reference from your OpenAPI file

Upload an OpenAPI 3 file or connect it from your repo. Signcodify builds a page for every endpoint, with parameters, examples and a request panel, and rebuilds it when the file changes.

GET/v1/projects/{project_id}

Retrieve a project

Returns a single project. Generated from the operation getProject in openapi.yaml.

Path parameters

project_id stringThe id of the project, starting with prj_.required
expand string, queryInclude related objects, for example members.optional
curl https://api.lumenpay.com/v1/projects/prj_8f2c41 \
  -H "Authorization: Bearer $LUMEN_KEY"

Try it

Readers send a real request from the page with their own test key. Here it answers with a mock.

Try a wrong id, or clear it, to see the error responses.

ResponseMock response

Press Send request to see what the endpoint returns.

Warning. Requests from Try it go straight from the reader's browser to your API. Allow your docs domain in CORS, and only accept test keys there.

Let readers ask the docs

Ask AI answers questions in plain language, using only your published pages, and shows the pages it used. If the docs do not say, it says so.

Pick a question above, or type your own. Answers cite the pages they come from.

See what readers look for

Know which pages people read, what they search for and do not find, and which pages went stale after a code change.

Example report for a sample docs site, last 30 days.

Top pages

  • Quickstart1,840 views
  • Authentication1,312 views
  • Webhooks966 views
  • Errors604 views

Searches with no result

  • “refund in another currency”38 searchesWrite this page
  • “sandbox reset”21 searchesWrite this page
  • “terraform provider”12 searchesWrite this page

Webhooks may be out of date

It documents src/webhooks/retry.ts, which changed 3 days ago. The retry schedule in the code no longer matches the page.

Sent to the page owner

Start from a template

Five templates engineering teams use every week. Each one has guidance per section and example content you can keep.

All templates

Pricing

Readers are always free. You pay for the people who write and publish.

MonthlyYearly2 months free

Free

$0for one small team

One public space for a side project or an early product.

  • 1 space, up to 3 editors
  • Block editor and templates
  • signcodify.com address
  • Search for readers
Start free

Team

Most teams

$12per editor a month

For teams shipping an API or a product with real users.

  • Unlimited spaces
  • Git sync with GitHub and GitLab
  • API reference and Try it
  • Ask AI and analytics
  • Custom domain and branding
  • Versions and changelog
Start a free trial

Business

$27per editor a month

For companies with private docs and stricter access rules.

  • Everything in Team
  • Private pages and reader sign-in
  • SSO and roles
  • Stale-page alerts
  • Audit log
Talk to us

Prices in US dollars. Open source projects and nonprofits get Team for free: write to us.

Questions

Yes. Connect the repository or upload a folder. Signcodify keeps your file structure, front matter and images, and writes changes back as pull requests.

Not for public pages. Private pages ask readers to sign in, and you choose who can see them by role or email domain.

Only from pages you have published in that space. Private pages are used only for readers who are allowed to see them, and every answer links to its sources.

Your docs are Markdown in your own repository the whole time. Export a space as a zip of Markdown files from Settings at any point.