Skip to content

Writing a doc ​

Every page on this site is a Markdown (.md) file in the docs-site/ folder of the website repo. The file path becomes the URL:

FileURL
docs-site/solutions/running-payroll.mddocs.momentumdatasolutions.com/solutions/running-payroll
docs-site/compliance/data-retention.mddocs.momentumdatasolutions.com/compliance/data-retention

Add a page ​

  1. Pick a section folder: getting-started/, solutions/, platforms/, compliance/, developers/ or reference/.
  2. Copy the template below into a new file. Use lowercase words joined by dashes for the file name.
  3. Add the page to the sidebar in docs-site/.vitepress/config.mts under its section.
  4. Commit and push. Vercel publishes it in about a minute.

Not ready to publish yet? Drop the draft in docs-site/_inbox/ — anything in that folder is kept in the repo but not published.

Template ​

md
---
title: Running payroll
description: One sentence that shows up in search results.
---

# Running payroll

Who this is for and what they'll be able to do after reading it.

## Before you start

- What they need (access, files, dates)

## Steps

1. First step
2. Second step

## Troubleshooting

**Problem** — what to do about it.

Handy formatting ​

TIP

Use a tip box for helpful hints.

WARNING

Use a warning box for things that can go wrong.

DANGER

Use a danger box for anything involving employee data, pay or compliance.

Layout pieces ​

Numbered steps — wrap ### step headings in a steps block (leave blank lines inside):

md
<div class="steps">

### First step
What to do.

### Second step
What to do next.

</div>

Link cards — for "where to go next" sections:

md
<CardGrid>
  <Card icon="shield" title="Data handling" link="/compliance/data-handling">Short description.</Card>
</CardGrid>

Icons: rocket, database, users, wallet, calendar, cloud, shield, code, file, plug, book, help.

Opening line — <p class="lede">One sentence summary.</p> under the title.

Screenshots — put images in docs-site/public/ and add a frame: ![Sign-in screen](/signin.png){.shot}

Smarter Data | Stronger HR | Seamless Payroll