Skip to content

Commit 9cf561e

Browse files
leoj3nleoj3n
committed
Add docs for generated stuff
1 parent b7e1227 commit 9cf561e

File tree

13 files changed

+212
-0
lines changed

13 files changed

+212
-0
lines changed

‎site/generated/static/build/build.html.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
@parent bit-docs-generate-html/site/static/build/buildHash
2+
@module bit-docs-generate-html/site/static/build/buildHash/build.html
3+
4+
@description An unmodified copy of
5+
[bit-docs-generate-html/site/default/static/build.html].
6+
7+
@body

‎site/generated/static/build/build.js.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
@parent bit-docs-generate-html/site/static/build/buildHash
2+
@module bit-docs-generate-html/site/static/build/buildHash/build.js
3+
4+
@description An unmodified copy of
5+
[bit-docs-generate-html/site/default/static/build.js].
6+
7+
@body
8+
9+
Gets required and executed by [bit-docs-generate-html/build/static_dist].

‎site/generated/static/build/buildHash.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
@parent bit-docs-generate-html/generated
2+
@module bit-docs-generate-html/site/static/build/buildHash
3+
4+
@description Generated directory that contains copied/built files for the
5+
generated website.
6+
7+
@body
8+
9+
- [bit-docs-generate-html/site/static/build/buildHash/build.html]
10+
- [bit-docs-generate-html/site/static/build/buildHash/build.js]
11+
- [bit-docs-generate-html/site/static/build/buildHash/dist]
12+
- [bit-docs-generate-html/site/static/build/buildHash/package.json]
13+
- [bit-docs-generate-html/site/static/build/buildHash/packages.js]
14+
- [bit-docs-generate-html/site/static/build/buildHash/static.js]
15+
- [bit-docs-generate-html/site/static/build/buildHash/styles]
16+
17+
See [bit-docs-generate-html/build/build_hash] for information about how the
18+
`buildHash` hash is generated.

‎site/generated/static/build/dist.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
@parent bit-docs-generate-html/site/static/build/buildHash
2+
@module bit-docs-generate-html/site/static/build/buildHash/dist
3+
4+
@description An unmodified copy of the generated directory
5+
[bit-docs-generate-html/site/static/dist/buildHash].
6+
7+
@body

‎site/generated/static/build/package.json.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
@parent bit-docs-generate-html/site/static/build/buildHash
2+
@module bit-docs-generate-html/site/static/build/buildHash/package.json
3+
4+
@description A modified copy of
5+
[bit-docs-generate-html/site/default/static/package.json].
6+
7+
@body
8+
9+
Gets updated with any plugins that hooked into `dependencies` of the `html`
10+
hook:
11+
12+
```js
13+
{
14+
"name": "bit-docs-site",
15+
"version": "0.0.1",
16+
"description": "A site to be built",
17+
"main": "static.js",
18+
"scripts": {
19+
"test": "echo \"Error: no test specified\" && exit 1"
20+
},
21+
"steal": {
22+
"plugins": [
23+
"steal-less"
24+
]
25+
},
26+
"author": "Bitovi",
27+
"license": "MIT",
28+
"dependencies": {
29+
"steal": "1.X",
30+
"steal-less": "1.X",
31+
"bit-docs-html-toc": "0.6.2",
32+
"bit-docs-js": "0.0.6",
33+
"bit-docs-prettify": "0.1.1",
34+
"bit-docs-html-highlight-line": "0.2.3",
35+
"bit-docs-tag-demo": "0.3.0"
36+
}
37+
}
38+
```
39+
40+
The listed dependencies are installed by bit-docs using
41+
[enpeem](https://www.npmjs.com/package/enpeem) which makes them available for
42+
use by steal on the front end of the generated website.

‎site/generated/static/build/packages.js.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
@parent bit-docs-generate-html/site/static/build/buildHash
2+
@module {{}} bit-docs-generate-html/site/static/build/buildHash/packages.js
3+
4+
@description A modified copy of
5+
[bit-docs-generate-html/site/default/static/packages.js].
6+
7+
@body
8+
9+
Depending on what plugins you're using, gets updated to look like this:
10+
11+
```js
12+
function callIfFunction(value){
13+
if(typeof value === "function") {
14+
value();
15+
}
16+
return value;
17+
}
18+
module.exports = {
19+
"bit-docs-html-toc": callIfFunction( require("bit-docs-html-toc") ),
20+
"bit-docs-js": callIfFunction( require("bit-docs-js") ),
21+
"bit-docs-prettify": callIfFunction( require("bit-docs-prettify") ),
22+
"bit-docs-html-highlight-line": callIfFunction( require("bit-docs-html-highlight-line") ),
23+
"bit-docs-tag-demo": callIfFunction( require("bit-docs-tag-demo") )};
24+
```
25+
26+
This generated module requires front end plugins and calls them if the `main`
27+
of their `package.json` points to a JavaScript file that exports a function.
28+
For an example of a plugin that exports a front end function, see
29+
[bit-docs-prettify/prettify.js].

‎site/generated/static/build/static.js.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
@parent bit-docs-generate-html/site/static/build/buildHash
2+
@module bit-docs-generate-html/site/static/build/buildHash/static.js
3+
4+
@description An unmodified copy of
5+
[bit-docs-generate-html/site/default/static/static.js].
6+
7+
@body
8+
9+
Tells steal to require
10+
[bit-docs-generate-html/site/static/build/buildHash/packages.js] and
11+
`styles.less` from
12+
[bit-docs-generate-html/site/static/build/buildHash/styles], and sets up a
13+
global `window.PACKAGES` variable:
14+
15+
```js
16+
var packages = require("./packages");
17+
require("./styles/styles.less!");
18+
window.PACKAGES = packages;
19+
```
20+
21+
Gets compiled by steal, and becomes
22+
[bit-docs-generate-html/site/static/dist/buildHash/bundles/bit-docs-site/static.js]

‎site/generated/static/build/styles.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
@parent bit-docs-generate-html/site/static/build/buildHash
2+
@module bit-docs-generate-html/site/static/build/buildHash/styles
3+
4+
@description Directory that contains less files for the generated website.
5+
6+
@body
7+
8+
If the default theme is being used, this directory will contain copies of:
9+
- [bit-docs-generate-html/site/default/static/styles/mixins.less]
10+
- [bit-docs-generate-html/site/default/static/styles/styles.less]
11+
- [bit-docs-generate-html/site/default/static/styles/variables.less]
12+
13+
Gets compiled by steal, and becomes
14+
[bit-docs-generate-html/site/static/dist/buildHash/bundles/bit-docs-site/static.css]

‎site/generated/static/dist/buildHash.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
@parent bit-docs-generate-html/generated
2+
@module bit-docs-generate-html/site/static/dist/buildHash
3+
4+
@description Generated directory that contains minified distributable files
5+
for the generated website.
6+
7+
@body
8+
9+
- [bit-docs-generate-html/site/static/dist/buildHash/bundles/bit-docs-site/static.css]
10+
- [bit-docs-generate-html/site/static/dist/buildHash/bundles/bit-docs-site/static.js]
11+
- [bit-docs-generate-html/site/static/dist/buildHash/steal.production.js]
12+
13+
Gets copied to [bit-docs-generate-html/site/static/build/buildHash/dist]
14+
15+
See [bit-docs-generate-html/build/build_hash] for information about how the
16+
`buildHash` hash is generated.

‎site/generated/static/dist/static.css.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
@parent bit-docs-generate-html/site/static/dist/buildHash
2+
@module bit-docs-generate-html/site/static/dist/buildHash/bundles/bit-docs-site/static.css
3+
4+
@description Less styles compiled into css for the front end of the generated
5+
website.
6+
7+
@body
8+
9+
Gets compiled by steal because of
10+
[bit-docs-generate-html/site/static/build/buildHash/static.js].

0 commit comments

Comments
 (0)