Skip to content

Suggestion: Add brief contextual descriptions to list items, or convert lists to tables #29

@hey-august

Description

@hey-august

This list could be enhanced with little impact to usability by the addition of a short explanatory sentence after each bullet point.

Example

Site Generators

  • Antora - Docs-as-code SSG for AsciiDoc
  • Asciidoctor - text processor publishing toolchain for AsciiDoc, exporting to many web and print formats
  • Docusaurus - Powerful docs-as-code SSG for Markdown and Markdown React (MDX) designed for docs sites
  • Astro - Web framework and SSG with docs template (see Starlight) with support for Markdown, MDX, Markdoc

This adds additional context without making the lists overly bloated.

Table format example

While this would entail a larger reorganization of content, a table format could be implemented to organize additional information about items.

Site Generators

Site Generator Open-source? Supported languages Notes
Antora AsciiDoc Developed by the Asciidoctor maintainers
Asciidoctor AsciiDoc Run with Ruby or JS
Docusaurus Markdown, Markdown React (MDX) Docs-focused SSG
Astro Markdown, Markdown React (MDX), Markdoc Multipurpose framework and SSG; the Starlight template is designed for docs sites

This would be a more intensive reorganization. The table format adds additional organization and information capabilities, but reduces ease of maintainability.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions