From b5110eaa0b1eae32b265ea07e03d06380cadf6c9 Mon Sep 17 00:00:00 2001 From: Ruy Adorno Date: Tue, 5 Nov 2019 12:43:35 -0500 Subject: docs: removed refs to npm-index --- README.md | 1 - docs/content/cli-commands/npm-help.md | 1 - scripts/index-build.js | 58 ----------------------------------- 3 files changed, 60 deletions(-) delete mode 100755 scripts/index-build.js diff --git a/README.md b/README.md index bb33879fd..16c7e4b18 100644 --- a/README.md +++ b/README.md @@ -163,4 +163,3 @@ doubt tell you to put the output in a gist or email. * npm(1) * npm-help(1) -* npm-index(7) diff --git a/docs/content/cli-commands/npm-help.md b/docs/content/cli-commands/npm-help.md index 724382aae..c5fbbe78c 100755 --- a/docs/content/cli-commands/npm-help.md +++ b/docs/content/cli-commands/npm-help.md @@ -42,4 +42,3 @@ Set to `"browser"` to view html help content in the default web browser. * [npmrc](/configuring-npm/npmrc) * [package.json](/configuring-npm/package-json) * [npm help-search](/cli-commands/npm-help-search) -* [npm index](/cli-commands/npm-index) diff --git a/scripts/index-build.js b/scripts/index-build.js deleted file mode 100755 index e782716d7..000000000 --- a/scripts/index-build.js +++ /dev/null @@ -1,58 +0,0 @@ -#!/usr/bin/env node -var fs = require('fs') -var path = require('path') -var root = path.resolve(__dirname, '..') -var glob = require('glob') -var conversion = { 'cli': 1, 'api': 3, 'files': 5, 'misc': 7 } - -glob(root + '/{README.md,doc/*/*.md}', function (er, files) { - if (er) throw er - - output(files.map(function (f) { - var b = path.basename(f) - if (b === 'README.md') return [0, b] - if (b === 'index.md') return null - var s = conversion[path.basename(path.dirname(f))] - return [s, f] - }).filter(function (f) { - return f - }).sort(function (a, b) { - return (a[0] === b[0]) - ? (path.basename(a[1]) === 'npm.md' ? -1 - : path.basename(b[1]) === 'npm.md' ? 1 - : a[1] > b[1] ? 1 : -1) - : a[0] - b[0] - })) -}) - -function output (files) { - console.log( - 'npm-index(7) -- Index of all npm documentation\n' + - '==============================================\n') - - writeLines(files, 0) - writeLines(files, 1, 'Command Line Documentation', 'Using npm on the command line') - writeLines(files, 3, 'API Documentation', 'Using npm in your Node programs') - writeLines(files, 5, 'Files', 'File system structures npm uses') - writeLines(files, 7, 'Misc', 'Various other bits and bobs') -} - -function writeLines (files, sxn, heading, desc) { - if (heading) { - console.log('## %s\n\n%s\n', heading, desc) - } - files.filter(function (f) { - return f[0] === sxn - }).forEach(writeLine) -} - -function writeLine (sd) { - var sxn = sd[0] || 1 - var doc = sd[1] - var d = path.basename(doc, '.md') - - var content = fs.readFileSync(doc, 'utf8').split('\n')[0].split('-- ')[1] - - console.log('### %s(%d)\n', d, sxn) - console.log(content + '\n') -} -- cgit v1.2.3