mirror of https://github.com/dart-lang/sdk synced 2024-09-05 00:13:50 +00:00

History

Nate Bosch 6ebd2633cd Use `any` deps for all unpublished packages It should not be necessary to ever run `pub get` for a package which is not published. All packages used in the SDK are controlled by a single package config, so it's not necessary to declare versions or paths for any packages. Remove all dependency overrides. R=devoncarew@google.com Change-Id: Icb328813b471f35ee4c99995f4e90aac4d8ed438 Tested: Covered by existing static analysis. Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/244767 Commit-Queue: Nate Bosch <nbosch@google.com> Reviewed-by: Alexander Aprelev <aam@google.com> Reviewed-by: Devon Carew <devoncarew@google.com>		2022-05-17 01:22:25 +00:00
..
build
CustomShellSessionPygmentsLexer
styles
templates
xref_extractor	Use `any` deps for all unpublished packages	2022-05-17 01:22:25 +00:00
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

Asides

Paragraphs wrapped into <aside>...</aside> will be rendered as a sidenote on margins of the page.

Cross-references are rendered as links to GitHub at the current commit.

@{file-path} is just rendered a link to the given file;
@{package:name/path.dart} is rendered as a link to file path.dart within package name - actual path is resolved via root .packages file in the SDK root;
@{c++-symbol} is rendered as a link to the line in the file which defines the given C++ symbol.

Install all Python dependencies.

$ pip3 install coloredlogs jinja2 markdown aiohttp watchdog pymdown-extensions pygments

Install the custom pygments lexer we use for shell session examples:

$ cd runtime/tools/wiki/CustomShellSessionPygmentsLexer
$ python3 setup.py develop