Skip to main content

Contribute to the docs

Learn about contributing to the Dart and Flutter documentation sites.

Contribution guides

#

Repository layout

#
  • .github/

    Configuration for GitHub actions, issue and PR templates, and dependabot.

  • cloud_build/

    Configuration for Google Cloud Build that is used for staging and deploying the site.

  • diagrams/

    Source files for diagrams used on the site.

  • examples/

    The source files for code excerpts used in doc code blocks.

  • src/

    • _11ty/

      Custom extensions for 11ty, Liquid, and Markdown.

      • plugins/

      • syntax/

        Shiki themes for syntax highlighting.

      • filters.ts

      • shortcodes.ts

    • _data/

      YAML and JSON files used to add data used across site templates.

    • _includes/

      Partial files used by liquid render and include statements.

    • _layouts/

      Layout templates used by the pages on the site.

    • _sass/

      Styles for the generated documentation, written with sass.

    • content/

      The root directory for the content of the site.

      • assets/

        The directory for assets, including images, used by the site.

      • ...

        The other directories hosting the site content.

  • tool/

    • dash_site/

      The implementation directories for the dash_site tooling.

  • dash_site

    The entrypoint script for the site's CLI tool.

  • eleventy.config.ts

    The entrypoint for the site's 11ty static-site generation setup.

  • firebase.json

    Configuration for Firebase Hosting that is used for the staged and deployed sites.

  • package.json

    Configuration of used npm dependencies.