mirror of
https://github.com/dart-lang/sdk
synced 2024-10-14 16:37:43 +00:00
3128c61d1a
R=kevmoo@google.com TEST=docs only change Change-Id: I7e0f3a8fd7d4917dead0e8e4c80c0bbdd0ff591c Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/283683 Reviewed-by: Kevin Moore <kevmoo@google.com> |
||
---|---|---|
.. | ||
build | ||
styles | ||
templates | ||
README.md |
This directory contains helper scripts for rendering runtime wiki pages as HTML.
# Run webserver for development.
$ runtime/tools/wiki/build/build.py
# Build wiki for deployment
$ runtime/tools/wiki/build/build.py --deploy
Markdown extensions
Admonitions and Asides
Blockquotes starting with > **Marker**
are converted either:
- into sidenotes (if
Marker
isNote
), which will be rendered on margins of the page; - admonitions (if
Marker
isSource to read
,Trying it
orWarning
).
Referencing C++ symbols and files
Script extends Markdown references with special support for references that
use [`ref`][]
and [text][`ref`]
. The following values for ref
are
recognized and resolved as links to GitHub at the current commit.
file-path
is resolved as a link to the given file;package:name/path.dart
is resolved as a link to filepath.dart
within packagename
- actual path is resolved via.dart_tool/package_config.json
file in the SDK root;c++ symbol
is resolved as a link to the line in the file which defines the given C++ symbol.
If markdown file contains any references in this form then running
runtime/tools/wiki/build/build.py --deploy
will generate a reference
section at the end of the file. Appending this section allows other Markdown
tools (e.g. GitHub viewer) to render such special links correctly.
Prerequisites
- Install all Python dependencies.
$ pip3 install coloredlogs jinja2 markdown aiohttp watchdog pymdown-extensions pygments
- Install
libclang
(brew install llvm
on Mac OS X). - Install SASS compiler (make sure that SASS binary is in your path).