mirror of https://github.com/docker/docs.git
bfce18c90b
This is an initial "experiment" on making codeblocks more useful; it's
just a quick implementation, and can use a lot of improvements, but we
can see if it's useful in its current form already (as a starting point).
More context below:
With example blocks being parsed/highlighted by rouge, we should be able
to pick keywords from them; for example, in the highlighted Dockerfile
examples, we can show tool-tips (even a hover-card) with more details
about the command.
Shell examples may be a bit more involved, but we could still detect;
- adjacent keywords (`docker` + `run` => `docker run`)
- with the yaml-docs we have (we could generate JSON and upload them
as a "database"), we could even do an AJAX call to dynamically
fetch flag descriptions, etc.
This very quick and dirty test adds tooltips to Dockerfile commands
in examples. When hovering, it shoulds a tooltip ("click for more
information about this command"), and when clicking, navigates to the
Dockerfile reference.
Ideally, we wouldn't navigate away from the current page for initial
details (instead, we should present a rich hoverbox / pane), to provide
the user with more details without interrupting the article they were
reading.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
|
||
|---|---|---|
| .. | ||
| anchorlinks.js | ||
| bootstrap.min.js | ||
| docs.js | ||
| jquery.js | ||
| metadata.json | ||
| redoc.min.js | ||
| redoc.min.map | ||
| search.js | ||
| theme-switcher.js | ||
| toc.json | ||