Code Monkey home page Code Monkey logo

awesome-docs's People

Contributors

0anas01 avatar begleynk avatar cadamini avatar christophedujarric avatar dependabot[bot] avatar hey-august avatar omerr avatar stolkmeister avatar svx avatar thomvaill avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

awesome-docs's Issues

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

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.