← Back to the guide

Getting started with Transcriber

This is a seed article. It exists so the guide section has something to render, so the listing, the individual post route and the RSS feed can all be verified end to end. Replace or delete it once real content exists.

How this section works

Each article is one MDX file under src/content/guide/<locale>/, named YYYY-MM-DD-slug.mdx. The date in the filename is only for ordering the files on disk — the publishDate field in the frontmatter is what the site actually sorts and displays.

Adding an article

  1. Create src/content/guide/en/YYYY-MM-DD-your-slug.mdx.
  2. Fill in the frontmatter. title and description are used verbatim as the <title> and <meta name="description">, so write them as real SEO copy — roughly 60 and 155 characters.
  3. Set isDraft: true while you work. Draft articles are still built and reachable by direct URL, but they stay out of the listing, the feed and the sitemap, and they are marked noindex.
  4. Write the article body below the frontmatter in Markdown or MDX.
  5. Create the German counterpart at src/content/guide/de/ with the same slug, and point linkedLocale at it from both files.
  6. Set isDraft: false and open a pull request. The preview link posted on the PR shows the article in both languages before anything goes live.

Formatting

Standard Markdown works throughout — headings, lists, tables, and fenced code blocks:

npm run dev

Because these are MDX files, Astro components can be imported and used directly in the body when an article needs something richer than Markdown provides.

  • basics
  • setup