1Stardoc is a documentation generator for [Bazel](https://bazel.build) build rules 2written in [Starlark](https://bazel.build/docs/skylark/index.html). 3 4Stardoc provides a Starlark rule (`stardoc`) 5that can be used to build Markdown documentation for Starlark rules, providers, 6and functions. 7Starlark generates one documentation page per `stardoc` target. 8 9If you are new to writing build rules for Bazel, please read the Bazel 10documentation on [writing 11extensions](https://bazel.build/extending/concepts) 12 13## Setup 14 15Edit your `WORKSPACE` file as shown in the `WORKSPACE` setup section for 16[the current Stardoc release](https://github.com/bazelbuild/stardoc/releases). 17 18Then add 19 20```python 21load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc") 22``` 23 24to your `BUILD` or .bzl file to start using the `stardoc` rule. 25 26## Next Steps 27 28Now you are ready to document your Starlark rules. 29 30* Learn about the [docstring format](writing_stardoc.md) used to document Starlark rules. 31* Learn about how you can use Stardoc's [build rules](generating_stardoc.md) to generate your 32 documentation in Markdown format. 33 34 35