1# Stardoc - Starlark Documentation Generator 2 3[](https://buildkite.com/bazel/stardoc) 4 5Stardoc is a documentation generator for [Bazel](https://bazel.build) build rules 6written in [Starlark](https://bazel.build/docs/skylark/index.html). 7 8Stardoc provides a Starlark rule (`stardoc`, see [documentation](docs/stardoc_rule.md)) that can 9be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation 10page per `.bzl`file. 11 12## Get Started 13 14* How to [set up Stardoc for your project](docs/getting_started_stardoc.md) 15* Writing [docstrings](docs/writing_stardoc.md) 16* How to [integrate Stardoc with your build](docs/generating_stardoc.md). 17* See also [Advanced Topics](docs/advanced_stardoc_usage.md). 18 19## About Stardoc 20 21* Stardoc [rule reference](docs/stardoc_rule.md). 22* How to [contribute to Stardoc](docs/contributing.md) 23 24## Project Status 25 26### Skydoc deprecation 27 28Stardoc is a replacement for the **deprecated** "Skydoc" documentation generator. 29 30See [Skydoc Deprecation](docs/skydoc_deprecation.md) for 31details on the deprecation and migration details. 32 33### Future plans 34 35See our [future plans](docs/future_plans.md) for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project. 36 37### Maintainer's guide 38 39See the [maintaner's guide](docs/maintainers_guide.md) for instructions for 40cutting a new release. 41 42
){kind=link}