docs: migrate existing docs to gatsby

- chore(docs): remove html from docs build
- feat(docs): migrate new Gatsby site to cli/docs
- chore(docs): fix docs url path
- chore(docs): add new build doc step
- chore(docs): add static linking
- chore(docs): add npm favicon
- chore(docs): update files for tests
- chore(docs): make relative paths absolute
- chore(docs): fix routing on docs dependant tests
- chore(docs): add prepublishOnly docs building step
- chore(docs): add docs/public to .gitignore
- chore(docs): rename dot json markdown files with hyphen names
- chore(docs): clean package.json
- chore(docs): highlight scripts in list
- chore(docs): add strong styles
- chore(docs): fix .json links on markdown
- Added copy to the features page
  - Added an install page (copied from existing online docs)
  - Added a FeatureLink component to components/links.js
- feat(docs): replace docs sh script with node
- chore(docs): fix docs building process
- chore(docs): docs folder cleanup

PR-URL: #274
Credit: @claudiahdz
Close: #274
Reviewed-by: @ruyadorno

Author: claudiahdz

.gitignore

@@ -8,7 +8,9 @@ npm-debug.log
 /test/packages/test-package/random-data.txt
 /test/root
 /node_modules/.bin
-/html/doc/
+/docs/public/
+/docs/.cache/
+/docs/node_modules/
 /man/
 /doc/*/npm-index.md
 /npmrc

Makefile

@@ -4,51 +4,25 @@ SHELL = bash
 PUBLISHTAG = $(shell node scripts/publish-tag.js)
 BRANCH = $(shell git rev-parse --abbrev-ref HEAD)
 
-markdowns = $(shell find doc -name '*.md' | grep -v 'index') README.md
+markdowns = $(shell find docs -name '*.md' | grep -v 'index') README.md
 
-html_docdeps = html/dochead.html \
-               html/docfoot.html \
-               scripts/doc-build.sh \
-               package.json
-
-cli_mandocs = $(shell find doc/cli -name '*.md' \
+cli_mandocs = $(shell find docs/content/cli-commands -name '*.md' \
                |sed 's|.md|.1|g' \
-               |sed 's|doc/cli/|man/man1/|g' ) \
+               |sed 's|docs/content/cli-commands/|man/man1/|g' ) \
                man/man1/npm-README.1 \
                man/man1/npx.1
 
-files_mandocs = $(shell find doc/files -name '*.md' \
+files_mandocs = $(shell find docs/content/configuring-npm -name '*.md' \
                |sed 's|.md|.5|g' \
-               |sed 's|doc/files/|man/man5/|g' ) \
-               man/man5/npm-json.5 \
-               man/man5/npm-global.5
+               |sed 's|docs/content/configuring-npm/|man/man5/|g' ) \
 
-misc_mandocs = $(shell find doc/misc -name '*.md' \
+misc_mandocs = $(shell find docs/content/using-npm -name '*.md' \
                |sed 's|.md|.7|g' \
-               |sed 's|doc/misc/|man/man7/|g' ) \
-               man/man7/npm-index.7
-
-cli_htmldocs = $(shell find doc/cli -name '*.md' \
-                |sed 's|.md|.html|g' \
-                |sed 's|doc/cli/|html/doc/cli/|g' ) \
-                html/doc/README.html
-
-files_htmldocs = $(shell find doc/files -name '*.md' \
-                  |sed 's|.md|.html|g' \
-                  |sed 's|doc/files/|html/doc/files/|g' ) \
-                  html/doc/files/npm-json.html \
-                  html/doc/files/npm-global.html
-
-misc_htmldocs = $(shell find doc/misc -name '*.md' \
-                 |sed 's|.md|.html|g' \
-                 |sed 's|doc/misc/|html/doc/misc/|g' ) \
-                 html/doc/index.html
+               |sed 's|docs/content/using-npm/|man/man7/|g' ) \
 
 mandocs = $(cli_mandocs) $(files_mandocs) $(misc_mandocs)
 
-htmldocs = $(cli_htmldocs) $(files_htmldocs) $(misc_htmldocs)
-
-all: doc
+all: docs
 
 latest:
 	@echo "Installing latest published npm"
@@ -65,88 +39,69 @@ dev: install
 link: uninstall
 	node bin/npm-cli.js link -f
 
-clean: markedclean marked-manclean doc-clean
+clean: markedclean marked-manclean docs-clean
 	rm -rf npmrc
 	node bin/npm-cli.js cache clean --force
 
 uninstall:
 	node bin/npm-cli.js rm npm -g -f
 
-doc: $(mandocs) $(htmldocs)
+mandocs: $(mandocs)
+
+htmldocs:
+	cd docs && node ../bin/npm-cli.js install && \
+	node ../bin/npm-cli.js run build:static echo>&2 && \
+	rm -rf node_modules .cache public/*js public/*json public/404* public/page-data public/manifest*
+	find docs/public -name '*.html' -exec \
+	node scripts/docs-build.js {} \;
+
+docs: mandocs htmldocs
 
 markedclean:
 	rm -rf node_modules/marked node_modules/.bin/marked .building_marked
 
 marked-manclean:
 	rm -rf node_modules/marked-man node_modules/.bin/marked-man .building_marked-man
 
-docclean: doc-clean
-doc-clean:
+docsclean: docs-clean
+docs-clean:
 	rm -rf \
     .building_marked \
     .building_marked-man \
-    html/doc \
-    man
+    man \
+    docs/node_modules \
+    docs/public \
+    docs/.cache
 
 ## build-time tools for the documentation
 build-doc-tools := node_modules/.bin/marked \
                    node_modules/.bin/marked-man
 
 # use `npm install marked-man` for this to work.
-man/man1/npm-README.1: README.md scripts/doc-build.sh package.json $(build-doc-tools)
+man/man1/npm-README.1: README.md scripts/docs-build.js package.json $(build-doc-tools)
 	@[ -d man/man1 ] || mkdir -p man/man1
-	scripts/doc-build.sh $< $@
+	node scripts/docs-build.js $< $@
 
-man/man1/%.1: doc/cli/%.md scripts/doc-build.sh package.json $(build-doc-tools)
+man/man1/%.1: docs/content/cli-commands/%.md scripts/docs-build.js package.json $(build-doc-tools)
 	@[ -d man/man1 ] || mkdir -p man/man1
-	scripts/doc-build.sh $< $@
+	node scripts/docs-build.js $< $@
 
 man/man1/npx.1: node_modules/libnpx/libnpx.1
 	cat $< | sed s/libnpx/npx/ > $@
 
 man/man5/npm-json.5: man/man5/package.json.5
 	cp $< $@
 
-man/man5/npm-global.5: man/man5/npm-folders.5
+man/man5/npm-global.5: man/man5/foslders.5
 	cp $< $@
 
-man/man5/%.5: doc/files/%.md scripts/doc-build.sh package.json $(build-doc-tools)
+man/man5/%.5: docs/content/configuring-npm/%.md scripts/docs-build.js package.json $(build-doc-tools)
 	@[ -d man/man5 ] || mkdir -p man/man5
-	scripts/doc-build.sh $< $@
-
-doc/misc/npm-index.md: scripts/index-build.js package.json $(build-doc-tools)
-	node scripts/index-build.js > $@
+	node scripts/docs-build.js $< $@
 
-html/doc/index.html: doc/misc/npm-index.md $(html_docdeps) $(build-doc-tools)
-	@[ -d html/doc ] || mkdir -p html/doc
-	scripts/doc-build.sh $< $@
-
-man/man7/%.7: doc/misc/%.md scripts/doc-build.sh package.json $(build-doc-tools)
+man/man7/%.7: docs/content/using-npm/%.md scripts/docs-build.js package.json $(build-doc-tools)
 	@[ -d man/man7 ] || mkdir -p man/man7
-	scripts/doc-build.sh $< $@
-
-html/doc/README.html: README.md $(html_docdeps) $(build-doc-tools)
-	@[ -d html/doc ] || mkdir -p html/doc
-	scripts/doc-build.sh $< $@
-
-html/doc/cli/%.html: doc/cli/%.md $(html_docdeps) $(build-doc-tools)
-	@[ -d html/doc/cli ] || mkdir -p html/doc/cli
-	scripts/doc-build.sh $< $@
-
-html/doc/files/npm-json.html: html/doc/files/package.json.html
-	cp $< $@
-
-html/doc/files/npm-global.html: html/doc/files/npm-folders.html
-	cp $< $@
-
-html/doc/files/%.html: doc/files/%.md $(html_docdeps) $(build-doc-tools)
-	@[ -d html/doc/files ] || mkdir -p html/doc/files
-	scripts/doc-build.sh $< $@
-
-html/doc/misc/%.html: doc/misc/%.md $(html_docdeps) $(build-doc-tools)
-	@[ -d html/doc/misc ] || mkdir -p html/doc/misc
-	scripts/doc-build.sh $< $@
-
+	node scripts/docs-build.js $< $@
 
 marked: node_modules/.bin/marked
 
@@ -158,11 +113,7 @@ marked-man: node_modules/.bin/marked-man
 node_modules/.bin/marked-man:
 	node bin/npm-cli.js install marked-man --no-global --no-timing --no-save
 
-doc: man
-
-man: $(cli_docs)
-
-test: doc
+test: docs
 	node bin/npm-cli.js test
 
 tag:
@@ -174,17 +125,17 @@ ls-ok:
 gitclean:
 	git clean -fd
 
-publish: gitclean ls-ok link doc-clean doc
+publish: gitclean ls-ok link docs-clean docs
 	@git push origin :v$(shell node bin/npm-cli.js --no-timing -v) 2>&1 || true
 	git push origin $(BRANCH) &&\
 	git push origin --tags &&\
 	node bin/npm-cli.js publish --tag=$(PUBLISHTAG)
 
-release: gitclean ls-ok markedclean marked-manclean doc-clean doc
+release: gitclean ls-ok markedclean marked-manclean docs-clean doc
 	node bin/npm-cli.js prune --production --no-save
 	@bash scripts/release.sh
 
 sandwich:
 	@[ $$(whoami) = "root" ] && (echo "ok"; echo "ham" > sandwich) || (echo "make it yourself" && exit 13)
 
-.PHONY: all latest install dev link doc clean uninstall test man doc-clean docclean release ls-ok realclean
+.PHONY: all latest install dev link doc clean uninstall test man docs-clean docclean release ls-ok realclean