Skip to content
Cubtera

Docs creation reference

  We’ve been following Diátaxis principles to create a better documentation experience. Here are some of the components and features we’ve used to create this documentation site.

  Diátaxis is primarily intended as a pragmatic approach for people working on documentation. Most of the key principles required to put it into practice successfully can be grasped intuitively.

  Don’t wait to understand Diátaxis before you start trying to put it into practice. Not only do you not need to understand it all to make use of it, you will not understand it until you have started using it (this itself is a Diátaxis principle).

  Diátaxis identifies four distinct needs, and four corresponding forms of documentation - tutorials, how-to guides, technical reference and explanation. It places them in a systematic relationship, and proposes that documentation should itself be organised around the structures of those needs.

Diátaxis

  More information about the Diátaxis principles can be found here.

Used Components

  We’ve been using following bellow components to create this documentation:

Code Snippets

example.js
console.log('This could come from a file or CMS!');

File tree

  • astro.config.mjs
  • package.json
  • Directorysrc
    • Directorycomponents
      • Header.astro
      • Title.astro
    • Directorypages/
      • …

Steps

  1. Import the component into your MDX file:

    import { Steps } from '@astrojs/starlight/components';

  2. Wrap <Steps> around your ordered list items.

Tabs

Single Tab

Sirius, Vega, Betelgeuse
Sync Tabs

Some stars:

Bellatrix, Rigel, Betelgeuse

Some exoplanets:

HD 34445 b, Gliese 179 b, Wasp-82 b

Asides

  • More information about current template’s components can be found here.
  • And learn more about building components in the Astro Docs here.