Skip to content
SmartDash SmartDash docs

Editing this documentation

This page provides links to the documentation of this very documentation site template. There you can read about the available components, options and how to work with the template.

Core system documentatin

  • Starlight template docs - Everything about how to set up and work with this documentation system.
  • Expressive Code - Documentation on the code sections plugin and additional capability plugins for it. This one for the “line numbers” plugin. Learn the plentiful great options on how to highlight lines, particular text instances, show added and deleted lines, include collapsible sections, install themes etc.
  • Astro docs - Starlight is based on the Astro framework and this link opens the Astro documentation. This very link will concretely take you to a page describing how to deploy your Astro site on GitHub Pages.

Additional installed tools

Components

  • Showcases Component Library - components to author showcase pages for your documentation.
  • Blog - adds a blog site to the docs system.
  • Image Zoom - adds image zoom capabilities to the documentation and blogs.
  • Heading Badges - enables badges to be easily added to headings and thus to the TOC sidebar, too.
  • Site Graph - shows a page dependency graph in the sidebar.
    • DISABLED: Maybe if the graph was under the “On this page” list or could be hidden and only the backlinks enabled, which would also be useful.
  • Sidebar Topics - lets us to split the documentation to two or more topics with each having its own sidebar hierarchy.

Plugins

  • LinksValidator - validates internal links upon running a production build.

For more plugins go here.

Possible future additions

  • Giscus - allows public comment block on pages using GitHub Giscus app.
  • FeelBack - helps collecting and analyzing of user feedback on the documentation.
  • Live Code - renders MDX code blocks as interactive components.
  • i18n - a Visual Studio Code extension to easily translate Starlight documentation pages using the built-in support for multilingual sites and git.
  • Starlight-To-PDF - A command-line tool for converting documentation websites built with 🌟Starlight into PDF files.