Skip to content
Help

Writing guide

Every page is a Markdown (.md) or MDX (.mdx) file under src/content/docs/. The file path is the URL: src/content/docs/publishers/import-data.mdx is served at /publishers/import-data/. Use .mdx only when a page needs one of the components below.

Frontmatter

Section titled “Frontmatter”
---
title: Import data            # Page heading and <title>
description: One sentence.    # Search results, link previews, section cards
sidebar:
  order: 3                    # Position among siblings in the side menu
appPaths:                     # Optional: in-app contextual help
  - /layer/:number:/edit/
---

Text, links and code

Section titled “Text, links and code”

Write normal Markdown. Link to other pages with root-relative URLs that end in /, such as the home page. Broken internal links fail the build.

from koordinates import Client
client = Client(host='labs.koordinates.com', token='...')

Images

Section titled “Images”

Put images in src/assets/, in a folder that matches the page path.

The Koordinates site icon

An image with a caption. Captions can contain Markdown.

For an image without a caption, plain Markdown also works: ![Alt text](~/assets/contributing/example.png).

Videos

Section titled “Videos”
A YouTube video with a caption.

Numbered steps

Section titled “Numbered steps”

  1. Open the dataset

    Go to the dataset page and select Export.

  2. Choose a format

    Pick a file format and coordinate system.

API actions

Section titled “API actions”
POST/services/api/v1.x/publish/Create a new publish task

Notes and warnings

Section titled “Notes and warnings”