diff options
| author | Luke Karrys <luke@lukekarrys.com> | 2022-03-31 03:39:21 +0300 |
|---|---|---|
| committer | Gar <wraithgar@github.com> | 2022-04-06 19:26:45 +0300 |
| commit | 03f36bf8c30b713e86f8e0b7e6643b68d74f7d91 (patch) | |
| tree | afc33df0328cfda57f8cb5e4a7126fc615f00281 /docs/lib | |
| parent | 840c338aa6aba7dc39d9d3afba075701e3979362 (diff) | |
chore(docs): move scripts and refactor
All docs related scripts are now located in the docs workspace
Diffstat (limited to 'docs/lib')
| -rw-r--r-- | docs/lib/config.json | 5 | ||||
| -rw-r--r-- | docs/lib/npm.js | 14 | ||||
| -rw-r--r-- | docs/lib/template.html | 163 |
3 files changed, 182 insertions, 0 deletions
diff --git a/docs/lib/config.json b/docs/lib/config.json new file mode 100644 index 000000000..c9f183e4e --- /dev/null +++ b/docs/lib/config.json @@ -0,0 +1,5 @@ +{ + "github_repo": "npm/cli", + "github_branch": "latest", + "github_path": "docs/content" +} diff --git a/docs/lib/npm.js b/docs/lib/npm.js new file mode 100644 index 000000000..fb801a17b --- /dev/null +++ b/docs/lib/npm.js @@ -0,0 +1,14 @@ +const { definitions, shorthands, describeAll } = require('../../lib/utils/config/index.js') +const { aliases } = require('../../lib/utils/cmd-list') +const Npm = require('../../lib/npm.js') + +// These are all the npm internals depended on by the docs scripts. If these change +// the associated targets should also be updated in the Makefile. + +module.exports = { + definitions, + shorthands, + describeAll, + aliases, + version: Npm.version, +} diff --git a/docs/lib/template.html b/docs/lib/template.html new file mode 100644 index 000000000..be3bafd61 --- /dev/null +++ b/docs/lib/template.html @@ -0,0 +1,163 @@ +<!DOCTYPE html> +<html> +<head> +<meta charset="utf-8"> +<title>{{ title }}</title> +<style> +body { + background-color: #ffffff; + color: #24292e; + + margin: 0; + + line-height: 1.5; + + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; +} +#rainbar { + height: 10px; + background-image: linear-gradient(139deg, #fb8817, #ff4b01, #c12127, #e02aff); +} + +a { + text-decoration: none; + color: #0366d6; +} +a:hover { + text-decoration: underline; +} + +pre { + margin: 1em 0px; + padding: 1em; + border: solid 1px #e1e4e8; + border-radius: 6px; + + display: block; + overflow: auto; + + white-space: pre; + + background-color: #f6f8fa; + color: #393a34; +} +code { + font-family: SFMono-Regular, Consolas, "Liberation Mono", Menlo, Courier, monospace; + font-size: 85%; + padding: 0.2em 0.4em; + background-color: #f6f8fa; + color: #393a34; +} +pre > code { + padding: 0; + background-color: inherit; + color: inherit; +} +h1, h2, h3 { + font-weight: 600; +} + +#logobar { + background-color: #333333; + margin: 0 auto; + padding: 1em 4em; +} +#logobar .logo { + float: left; +} +#logobar .title { + font-weight: 600; + color: #dddddd; + float: left; + margin: 5px 0 0 1em; +} +#logobar:after { + content: ""; + display: block; + clear: both; +} + +#content { + margin: 0 auto; + padding: 0 4em; +} + +#table_of_contents > h2 { + font-size: 1.17em; +} +#table_of_contents ul:first-child { + border: solid 1px #e1e4e8; + border-radius: 6px; + padding: 1em; + background-color: #f6f8fa; + color: #393a34; +} +#table_of_contents ul { + list-style-type: none; + padding-left: 1.5em; +} +#table_of_contents li { + font-size: 0.9em; +} +#table_of_contents li a { + color: #000000; +} + +header.title { + border-bottom: solid 1px #e1e4e8; +} +header.title > h1 { + margin-bottom: 0.25em; +} +header.title > .description { + display: block; + margin-bottom: 0.5em; + line-height: 1; +} + +footer#edit { + border-top: solid 1px #e1e4e8; + margin: 3em 0 4em 0; + padding-top: 2em; +} +</style> +</head> +<body> +<div id="banner"> +<div id="rainbar"></div> +<div id="logobar"> +<svg class="logo" role="img" height="32" width="32" viewbox="0 0 700 700"> +<polygon fill="#cb0000" points="0,700 700,700 700,0 0,0"></polygon> +<polygon fill="#ffffff" points="150,550 350,550 350,250 450,250 450,550 550,550 550,150 150,150"></polygon> +</svg> +<div class="title"> +npm command-line interface +</div> +</div> +</div> + +<section id="content"> +<header class="title"> +<h1>{{ title }}</h1> +<span class="description">{{ description }}</span> +</header> + +<section id="table_of_contents"> +<h2>Table of contents</h2> +{{ toc }} +</section> + +{{ content }} + +<footer id="edit"> +<a href="https://github.com/{{ config.github_repo }}/edit/{{ config.github_branch }}/{{ config.github_path }}/{{ url_path }}"> +<svg role="img" viewbox="0 0 16 16" width="16" height="16" fill="currentcolor" style="vertical-align: text-bottom; margin-right: 0.3em;"> +<path fill-rule="evenodd" d="M11.013 1.427a1.75 1.75 0 012.474 0l1.086 1.086a1.75 1.75 0 010 2.474l-8.61 8.61c-.21.21-.47.364-.756.445l-3.251.93a.75.75 0 01-.927-.928l.929-3.25a1.75 1.75 0 01.445-.758l8.61-8.61zm1.414 1.06a.25.25 0 00-.354 0L10.811 3.75l1.439 1.44 1.263-1.263a.25.25 0 000-.354l-1.086-1.086zM11.189 6.25L9.75 4.81l-6.286 6.287a.25.25 0 00-.064.108l-.558 1.953 1.953-.558a.249.249 0 00.108-.064l6.286-6.286z"></path> +</svg> +Edit this page on GitHub +</a> +</footer> +</section> + +</body> +</html> |