Skip to content

Bye bye submodules #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions .gitmodules

This file was deleted.

8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions docs/modules/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
1 change: 0 additions & 1 deletion docs/modules/bit-docs
Submodule bit-docs deleted from dae638
1 change: 0 additions & 1 deletion docs/modules/bit-docs-dev
Submodule bit-docs-dev deleted from e1d225
1 change: 0 additions & 1 deletion docs/modules/bit-docs-docjs-theme
Submodule bit-docs-docjs-theme deleted from 8ea70c
1 change: 0 additions & 1 deletion docs/modules/bit-docs-generate-html
Submodule bit-docs-generate-html deleted from d15f3f
1 change: 0 additions & 1 deletion docs/modules/bit-docs-generate-readme
Submodule bit-docs-generate-readme deleted from 3dcb5a
1 change: 0 additions & 1 deletion docs/modules/bit-docs-glob-finder
Submodule bit-docs-glob-finder deleted from 485ea8
1 change: 0 additions & 1 deletion docs/modules/bit-docs-html-highlight-line
Submodule bit-docs-html-highlight-line deleted from f29274
1 change: 0 additions & 1 deletion docs/modules/bit-docs-html-toc
Submodule bit-docs-html-toc deleted from 5244e0
1 change: 0 additions & 1 deletion docs/modules/bit-docs-js
Submodule bit-docs-js deleted from 240504
1 change: 0 additions & 1 deletion docs/modules/bit-docs-prettify
Submodule bit-docs-prettify deleted from 78b970
1 change: 0 additions & 1 deletion docs/modules/bit-docs-process-mustache
Submodule bit-docs-process-mustache deleted from 9d04f3
1 change: 0 additions & 1 deletion docs/modules/bit-docs-process-tags
Submodule bit-docs-process-tags deleted from 7fb258
1 change: 0 additions & 1 deletion docs/modules/bit-docs-tag-demo
Submodule bit-docs-tag-demo deleted from 1c1b82
1 change: 0 additions & 1 deletion docs/modules/bit-docs-tag-package
Submodule bit-docs-tag-package deleted from 4af235
1 change: 0 additions & 1 deletion docs/modules/bit-docs-tag-sourceref
Submodule bit-docs-tag-sourceref deleted from 9256bf
1 change: 0 additions & 1 deletion docs/modules/bit-docs-type-annotate
Submodule bit-docs-type-annotate deleted from 5d9d7d
29 changes: 29 additions & 0 deletions docs/modules/package.json
Original file line number Diff line number Diff line change
@@ -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"
}
}
34 changes: 17 additions & 17 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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 '↳ <https://bit-docs.github.io/bit-docs-website>'",
"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": {
Expand All @@ -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",
Expand All @@ -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
Expand Down