Writing guide

This page lists everything you can use inside a documentation page. Each example shows the rendered result, and the source is the file you are reading: content/docs/en/writing-guide.mdx.

File layoutCopy Anchor Link

Every language has its own folder. A page missing in French falls back to the English one, so write English first, then translate.

FrontmatterCopy Anchor Link

CalloutsCopy Anchor Link

StepsCopy Anchor Link

TabsCopy Anchor Link

Code blocksCopy Anchor Link

const revenue = orders.reduce((total, order) => total + order.total, 0) 

const before = "removed"
const after = "added"

curl https://docs.fullmetrix.com/en/llms.txt

npm install fullmetrix

AccordionCopy Anchor Link

CardsCopy Anchor Link

TablesCopy Anchor Link

ImagesCopy Anchor Link

Images are zoomable on click. Put files in public/images and reference them with /images/file.png.

ConventionsCopy Anchor Link

• Write short sentences, with simple words.
• Never use emojis, em-dashes or en-dashes as separators.
• Use correct French accents in French pages.
• Do not describe a feature you have not verified in the product.
• Name files in kebab-case and keep the same file name in both languages.
• A page that still shows the "Coming soon" callout is a stub. Replace the whole body, and keep the title and description accurate.
• Every page exists in both languages with the same file name. Write English first, then translate.
• In each folder, meta.json sets the order of the sidebar. A folder uses its own index.mdx as its landing page, so do not list index in its pages. A line like ---Label--- adds a section title.