Skip to content

Commit 03fd47e

Browse files
committed
start using submodules
1 parent 29475f3 commit 03fd47e

18 files changed

+78
-58
lines changed

.gitmodules

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
[submodule "docs/modules/bit-docs"]
2+
path = docs/modules/bit-docs
3+
url = https://github.com/bit-docs/bit-docs.git
4+
[submodule "docs/modules/bit-docs-dev"]
5+
path = docs/modules/bit-docs-dev
6+
url = https://github.com/bit-docs/bit-docs-dev.git
7+
[submodule "docs/modules/bit-docs-generate-html"]
8+
path = docs/modules/bit-docs-generate-html
9+
url = https://github.com/bit-docs/bit-docs-generate-html.git
10+
[submodule "docs/modules/bit-docs-generate-readme"]
11+
path = docs/modules/bit-docs-generate-readme
12+
url = https://github.com/bit-docs/bit-docs-generate-readme.git
13+
[submodule "docs/modules/bit-docs-glob-finder"]
14+
path = docs/modules/bit-docs-glob-finder
15+
url = https://github.com/bit-docs/bit-docs-glob-finder.git
16+
[submodule "docs/modules/bit-docs-js"]
17+
path = docs/modules/bit-docs-js
18+
url = https://github.com/bit-docs/bit-docs-js.git
19+
[submodule "docs/modules/bit-docs-process-mustache"]
20+
path = docs/modules/bit-docs-process-mustache
21+
url = https://github.com/bit-docs/bit-docs-process-mustache.git
22+
[submodule "docs/modules/bit-docs-process-tags"]
23+
path = docs/modules/bit-docs-process-tags
24+
url = https://github.com/bit-docs/bit-docs-process-tags.git
25+
[submodule "docs/modules/bit-docs-tag-sourceref"]
26+
path = docs/modules/bit-docs-tag-sourceref
27+
url = https://github.com/bit-docs/bit-docs-tag-sourceref.git
28+
[submodule "docs/modules/bit-docs-type-annotate"]
29+
path = docs/modules/bit-docs-type-annotate
30+
url = https://github.com/bit-docs/bit-docs-type-annotate.git
31+
[submodule "docs/modules/bit-docs-html-toc"]
32+
path = docs/modules/bit-docs-html-toc
33+
url = https://github.com/bit-docs/bit-docs-html-toc.git
34+
[submodule "docs/modules/bit-docs-tag-package"]
35+
path = docs/modules/bit-docs-tag-package
36+
url = https://github.com/bit-docs/bit-docs-tag-package.git
37+
[submodule "docs/modules/bit-docs-html-highlight-line"]
38+
path = docs/modules/bit-docs-html-highlight-line
39+
url = https://github.com/bit-docs/bit-docs-html-highlight-line.git
40+
[submodule "docs/modules/bit-docs-tag-demo"]
41+
path = docs/modules/bit-docs-tag-demo
42+
url = https://github.com/bit-docs/bit-docs-tag-demo.git

docs/bit-docs/high-level-overview.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
@page high-level-overview High Level Overview
22
@parent guides 0
33

4+
<div class="on-this-page-container"></div>
5+
46
Loosely based on ideas and lessons learned from [DocumentJS](http://documentjs.com), bit-docs is an evolving set of tools that allow you to:
57

68
- Write documentation inline, or in markdown files.
@@ -29,13 +31,13 @@ This paradigm of creating a repository dedicated to generating documentation wit
2931

3032
To use bit-docs, add it to the `package.json` of the project you want to use it in:
3133

32-
```
34+
```shell
3335
npm install bit-docs --save-dev
3436
```
3537

3638
Next, in your project's `package.json`, add a section called `bit-docs`, like:
3739

38-
```
40+
```json
3941
"bit-docs": {
4042
"dependencies": {
4143
"bit-docs-glob-finder": "*",
@@ -53,7 +55,7 @@ Next, in your project's `package.json`, add a section called `bit-docs`, like:
5355

5456
If you created a new repo specifically to hold this bit-docs stuff, you may wish to add the codebases you will be documenting as normal `package.json` devDependencies at this time. You will need to update the `bit-docs` glob pattern to be similar to what the StealJS website repo does (to tell the glob finder to look in `node_modules` for files to process):
5557

56-
```
58+
```json
5759
"glob": {
5860
"pattern": "{node_modules,doc}/{steal,grunt-steal,steal-*}/**/*.{js,md}",
5961
"ignore": [

docs/modules/bit-docs

Submodule bit-docs added at 85db648

docs/modules/bit-docs-dev

Submodule bit-docs-dev added at 660a2cf

docs/modules/bit-docs-generate-html

Submodule bit-docs-generate-html added at ceecae6

docs/modules/bit-docs-glob-finder

Submodule bit-docs-glob-finder added at f47dba7

docs/modules/bit-docs-html-toc

Submodule bit-docs-html-toc added at 6a5e018

docs/modules/bit-docs-js

Submodule bit-docs-js added at c583015

0 commit comments

Comments
 (0)