diff --git a/.gitmodules b/.gitmodules deleted file mode 100644 index 10bdc3d..0000000 --- a/.gitmodules +++ /dev/null @@ -1,48 +0,0 @@ -[submodule "docs/modules/bit-docs"] - path = docs/modules/bit-docs - url = https://github.com/bit-docs/bit-docs.git -[submodule "docs/modules/bit-docs-dev"] - path = docs/modules/bit-docs-dev - url = https://github.com/bit-docs/bit-docs-dev.git -[submodule "docs/modules/bit-docs-generate-html"] - path = docs/modules/bit-docs-generate-html - url = https://github.com/bit-docs/bit-docs-generate-html.git -[submodule "docs/modules/bit-docs-generate-readme"] - path = docs/modules/bit-docs-generate-readme - url = https://github.com/bit-docs/bit-docs-generate-readme.git -[submodule "docs/modules/bit-docs-glob-finder"] - path = docs/modules/bit-docs-glob-finder - url = https://github.com/bit-docs/bit-docs-glob-finder.git -[submodule "docs/modules/bit-docs-js"] - path = docs/modules/bit-docs-js - url = https://github.com/bit-docs/bit-docs-js.git -[submodule "docs/modules/bit-docs-process-mustache"] - path = docs/modules/bit-docs-process-mustache - url = https://github.com/bit-docs/bit-docs-process-mustache.git -[submodule "docs/modules/bit-docs-process-tags"] - path = docs/modules/bit-docs-process-tags - url = https://github.com/bit-docs/bit-docs-process-tags.git -[submodule "docs/modules/bit-docs-tag-sourceref"] - path = docs/modules/bit-docs-tag-sourceref - url = https://github.com/bit-docs/bit-docs-tag-sourceref.git -[submodule "docs/modules/bit-docs-type-annotate"] - path = docs/modules/bit-docs-type-annotate - url = https://github.com/bit-docs/bit-docs-type-annotate.git -[submodule "docs/modules/bit-docs-html-toc"] - path = docs/modules/bit-docs-html-toc - url = https://github.com/bit-docs/bit-docs-html-toc.git -[submodule "docs/modules/bit-docs-tag-package"] - path = docs/modules/bit-docs-tag-package - url = https://github.com/bit-docs/bit-docs-tag-package.git -[submodule "docs/modules/bit-docs-html-highlight-line"] - path = docs/modules/bit-docs-html-highlight-line - url = https://github.com/bit-docs/bit-docs-html-highlight-line.git -[submodule "docs/modules/bit-docs-tag-demo"] - path = docs/modules/bit-docs-tag-demo - url = https://github.com/bit-docs/bit-docs-tag-demo.git -[submodule "docs/modules/bit-docs-prettify"] - path = docs/modules/bit-docs-prettify - url = https://github.com/bit-docs/bit-docs-prettify.git -[submodule "docs/modules/bit-docs-docjs-theme"] - path = docs/modules/bit-docs-docjs-theme - url = https://github.com/bit-docs/bit-docs-docjs-theme.git diff --git a/README.md b/README.md index 79b88f3..853915d 100644 --- a/README.md +++ b/README.md @@ -52,12 +52,8 @@ available via `npm run-script`: bit-docs -df gh-pages # Publishes the website to GitHub Pages. gh-pages -d gh-pages - gsd # Shows submodule differences in git diff. - git diff --submodule - gsl # Prints a log graph highlighting submodule changes. - git log --graph --oneline -U0 --submodule | grep -E '^[*| /\]+([0-9a-f]{7} |Submodule |> |$)' - gsu # Fetch latest remote changes for submodules and merge them in. - git submodule update --remote --merge + install-modules # Installs the npm modules to be documented. + npm install --prefix docs/modules pub # Shortcut to publish the website to GitHub Pages. npm run gh-pages see # Preview the generated website using the globally installed http-server. diff --git a/docs/modules/.gitignore b/docs/modules/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/docs/modules/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/docs/modules/bit-docs b/docs/modules/bit-docs deleted file mode 160000 index dae638d..0000000 --- a/docs/modules/bit-docs +++ /dev/null @@ -1 +0,0 @@ -Subproject commit dae638de91a589313a342fc2d55362325def96fd diff --git a/docs/modules/bit-docs-dev b/docs/modules/bit-docs-dev deleted file mode 160000 index e1d2258..0000000 --- a/docs/modules/bit-docs-dev +++ /dev/null @@ -1 +0,0 @@ -Subproject commit e1d2258ad9ee180ac1b71ca23f8fe1e1c488861a diff --git a/docs/modules/bit-docs-docjs-theme b/docs/modules/bit-docs-docjs-theme deleted file mode 160000 index 8ea70cb..0000000 --- a/docs/modules/bit-docs-docjs-theme +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 8ea70cb153df5ebc103e1560301cf2c74a9cec71 diff --git a/docs/modules/bit-docs-generate-html b/docs/modules/bit-docs-generate-html deleted file mode 160000 index d15f3fb..0000000 --- a/docs/modules/bit-docs-generate-html +++ /dev/null @@ -1 +0,0 @@ -Subproject commit d15f3fbfb2c36179cb64c73e8386d35bb276292e diff --git a/docs/modules/bit-docs-generate-readme b/docs/modules/bit-docs-generate-readme deleted file mode 160000 index 3dcb5a4..0000000 --- a/docs/modules/bit-docs-generate-readme +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 3dcb5a4095b952bcf75e7e2de388b141ef4bb224 diff --git a/docs/modules/bit-docs-glob-finder b/docs/modules/bit-docs-glob-finder deleted file mode 160000 index 485ea8c..0000000 --- a/docs/modules/bit-docs-glob-finder +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 485ea8c4b539d21dd22dbb2a63ede1efc09801d4 diff --git a/docs/modules/bit-docs-html-highlight-line b/docs/modules/bit-docs-html-highlight-line deleted file mode 160000 index f29274d..0000000 --- a/docs/modules/bit-docs-html-highlight-line +++ /dev/null @@ -1 +0,0 @@ -Subproject commit f29274d62ba1171d4ef76b0fc5dcba17f99ceea1 diff --git a/docs/modules/bit-docs-html-toc b/docs/modules/bit-docs-html-toc deleted file mode 160000 index 5244e07..0000000 --- a/docs/modules/bit-docs-html-toc +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 5244e070a16f3d628b8ee112000ab706758c9944 diff --git a/docs/modules/bit-docs-js b/docs/modules/bit-docs-js deleted file mode 160000 index 2405049..0000000 --- a/docs/modules/bit-docs-js +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 2405049beea5df676714c468b4c6ae7594e44f05 diff --git a/docs/modules/bit-docs-prettify b/docs/modules/bit-docs-prettify deleted file mode 160000 index 78b970a..0000000 --- a/docs/modules/bit-docs-prettify +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 78b970a601a1d46770c1cc5e5e81c4d1cc27eca6 diff --git a/docs/modules/bit-docs-process-mustache b/docs/modules/bit-docs-process-mustache deleted file mode 160000 index 9d04f3d..0000000 --- a/docs/modules/bit-docs-process-mustache +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 9d04f3d78e4403a0578b72811b762fb89f5d6890 diff --git a/docs/modules/bit-docs-process-tags b/docs/modules/bit-docs-process-tags deleted file mode 160000 index 7fb2587..0000000 --- a/docs/modules/bit-docs-process-tags +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 7fb25876bfe661ed61fa30d4920bd1f5305cc19c diff --git a/docs/modules/bit-docs-tag-demo b/docs/modules/bit-docs-tag-demo deleted file mode 160000 index 1c1b824..0000000 --- a/docs/modules/bit-docs-tag-demo +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 1c1b82461fe7f6b9b37926f1e556630bacf07969 diff --git a/docs/modules/bit-docs-tag-package b/docs/modules/bit-docs-tag-package deleted file mode 160000 index 4af235c..0000000 --- a/docs/modules/bit-docs-tag-package +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 4af235c659418d8ba3b2029ca1af019628741e2e diff --git a/docs/modules/bit-docs-tag-sourceref b/docs/modules/bit-docs-tag-sourceref deleted file mode 160000 index 9256bf8..0000000 --- a/docs/modules/bit-docs-tag-sourceref +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 9256bf878410de42ae4682963897e708fec20ea8 diff --git a/docs/modules/bit-docs-type-annotate b/docs/modules/bit-docs-type-annotate deleted file mode 160000 index 5d9d7db..0000000 --- a/docs/modules/bit-docs-type-annotate +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 5d9d7dbf2b571afa11eb6064a84e161784ed1838 diff --git a/docs/modules/package.json b/docs/modules/package.json new file mode 100644 index 0000000..046b9f9 --- /dev/null +++ b/docs/modules/package.json @@ -0,0 +1,29 @@ +{ + "name": "modules", + "version": "1.0.0", + "description": "Modules containing documentation files.", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "devDependencies": { + "bit-docs": "pre", + "bit-docs-dev": "pre", + "bit-docs-docjs-theme": "latest", + "bit-docs-generate-html": "pre", + "bit-docs-generate-readme": "pre", + "bit-docs-glob-finder": "pre", + "bit-docs-html-highlight-line": "pre", + "bit-docs-html-toc": "pre", + "bit-docs-js": "pre", + "bit-docs-prettify": "pre", + "bit-docs-process-mustache": "pre", + "bit-docs-process-tags": "pre", + "bit-docs-tag-demo": "pre", + "bit-docs-tag-package": "pre", + "bit-docs-tag-sourceref": "pre", + "bit-docs-type-annotate": "pre" + } +} diff --git a/package.json b/package.json index 7dc5669..2402542 100644 --- a/package.json +++ b/package.json @@ -25,16 +25,14 @@ "gen": "bit-docs -d", "genf": "bit-docs -df", "gh-pages": "gh-pages -d gh-pages", - "gsd": "git diff --submodule", - "gsl": "git log --graph --oneline -U0 --submodule | grep -E '^[*| /\\]+([0-9a-f]{7} |Submodule |> |$)'", - "gsu": "git submodule update --remote --merge", - "preinstall": "[ -f docs/modules/bit-docs/package.json ] || git submodule update --init", + "postinstall": "[ -d docs/modules/node_modules ] || npm run install-modules", + "install-modules": "npm install --prefix docs/modules", "pub": "npm run gh-pages && echo '↳ '", "see": "http-server -a localhost -p 8080 -c-1 gh-pages", "test": "echo \"Error: no test specified\" && exit 1" }, "devDependencies": { - "bit-docs": "bit-docs/bit-docs", + "bit-docs": "pre", "gh-pages": "^0.12.0" }, "bit-docs": { @@ -45,19 +43,19 @@ ] }, "dependencies": { - "bit-docs-dev": "bit-docs/bit-docs-dev", - "bit-docs-generate-html": "bit-docs/bit-docs-generate-html", - "bit-docs-glob-finder": "bit-docs/bit-docs-glob-finder", - "bit-docs-html-toc": "bit-docs/bit-docs-html-toc", - "bit-docs-js": "bit-docs/bit-docs-js", - "bit-docs-prettify": "bit-docs/bit-docs-prettify", - "bit-docs-html-highlight-line": "bit-docs/bit-docs-html-highlight-line", - "bit-docs-process-mustache": "bit-docs/bit-docs-process-mustache", - "bit-docs-tag-demo": "bit-docs/bit-docs-tag-demo", - "bit-docs-tag-sourceref": "bit-docs/bit-docs-tag-sourceref" + "bit-docs-dev": "pre", + "bit-docs-generate-html": "pre", + "bit-docs-glob-finder": "pre", + "bit-docs-html-toc": "pre", + "bit-docs-js": "pre", + "bit-docs-prettify": "pre", + "bit-docs-html-highlight-line": "pre", + "bit-docs-process-mustache": "pre", + "bit-docs-tag-demo": "pre", + "bit-docs-tag-sourceref": "pre" }, "glob": { - "pattern": "docs/**/*.{js,md,mustache,less}", + "pattern": "docs/**/bit-docs*/**/*.{js,md,mustache,less}", "ignore": [ "**/README.md", "**/LICENSE.md", @@ -67,7 +65,9 @@ "**/test_*.js", "**/test-*.md", "**/test.js", - "**/node_modules/**/*", + "docs/modules/node_modules/**/node_modules/**/*", + "docs/modules/node_modules/bit-docs-generate-html/site/{static,templates}/**/*", + "docs/modules/node_modules/bit-docs-prettify/temp/**/*", "**/templates/**/*.mustache" ], "follow": true