# [Stardoc](https://skydoc.bazel.build) - Starlark Documentation Generator

[![Build status](https://badge.buildkite.com/c793ed98a3802393dba9813f524bfe28a87da2ab235df38c49.svg)](https://buildkite.com/bazel/skydoc-postsubmit)

Stardoc is a documentation generator for [Bazel](https://bazel.build) build rules
written in [Starlark](https://bazel.build/docs/skylark/index.html).

Stardoc provides a Starlark rule (`stardoc`) that can be used to build documentation
for Starlark rules in Markdown. Stardoc generates one documentation page per `.bzl` file.

## Skydoc deprecation

NOTE: Stardoc is a replacement for the **deprecated** "Skydoc" documentation generator.

See [Skydoc Deprecation](https://skydoc.bazel.build/docs/skydoc_deprecation.html) for
details on the deprecation, and for some migration tips.

## Get Started

* How to [set up Stardoc for your project](https://skydoc.bazel.build/docs/getting_started_stardoc.html)
* Writing [docstrings](https://skydoc.bazel.build/docs/writing_stardoc.html)
* How to [integrate Stardoc with your build](https://skydoc.bazel.build/docs/generating_stardoc.html).

## About Stardoc

* How to [contribute to Stardoc](https://skydoc.bazel.build/contributing.html)
* See the [Stardoc roadmap](https://skydoc.bazel.build/roadmap.html)




