| commit | 4736754e587ed3f69211fc8ddfb7f79798d2d95d | [log] [tgz] |
|---|---|---|
| author | Alexandre Rostovtsev <arostovtsev@google.com> | Tue Aug 01 16:06:06 2023 -0400 |
| committer | GitHub <noreply@github.com> | Tue Aug 01 16:06:06 2023 -0400 |
| tree | b057633129da514937bcb4e44963f9e370c6a864 | |
| parent | b124535d9022636a7fd41f702f111377a2125582 [diff] |
In Markdown table cells, apply HTML escaping only to code blocks, and apply it properly (#167)
In Markdown table cells, apply HTML escaping only to code blocks, and apply it properly
Since #161 removed HTML escaping for defaults and function docstrings, we should do the same for attribute and param docs in table cells.
The only limitations Markdown places on table cells are:
* no pipe characters (they must be escaped with a backslash)
* no newlines (they must be transformed into `<br>` or an HTML entity)
The latter restriction makes it impossible to have a fenced code block inside a table cell.
Therefore:
* we do not escape HTML or Markdown markup outside a fenced code block
* we keep existing logic for escaping newlines outside a fenced code block
* we fix fence detection (e.g. allowing more than 3 fence characters to support embedded code blocks in code blocks, allowing tildes as fence characters, properly handling language names, etc.);
* in code block content, we escape HTML, and we escape newlines as HTML entities (since `<br>` does not work in a `<pre><code>` block) - finally fixing code block newlines in table cells.
This is a followup to #161.
Partially addresses #118
Stardoc is a documentation generator for Bazel build rules written in Starlark.
Stardoc provides a Starlark rule (stardoc, see documentation) that can be used to build documentation for Starlark rules in Markdown. Stardoc generates one documentation page per .bzlfile.
Stardoc is a replacement for the deprecated “Skydoc” documentation generator.
See Skydoc Deprecation for details on the deprecation and migration details.
See our future plans for refactoring Stardoc to be more consistent with how Bazel evaluates .bzl files, and what it means for maintenance of this project.
See the maintaner's guide for instructions for cutting a new release.