Skip to content

Commit 8bc3a8f

Browse files
chasenleharaleoj3n
authored andcommitted
basics working
0 parents  commit 8bc3a8f

File tree

6 files changed

+147
-0
lines changed

6 files changed

+147
-0
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
gh-pages

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2017 [Bitovi](http://bitovi.com)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# website
2+
3+
Website that documents bit-docs.
4+
5+
## Commands
6+
7+
### Install Dependencies
8+
9+
```
10+
npm install
11+
```
12+
13+
### Generate Website
14+
15+
```
16+
npm run bit-docs
17+
```
18+
19+
### Preview Generated Website
20+
21+
```
22+
http-server gh-pages
23+
```
24+
25+
Now visit <http://127.0.0.1:8080/>
26+
27+
### Publish Generated Website to GitHub
28+
29+
```
30+
npm run gh-pages
31+
```
32+
33+
Now visit <https://bit-docs.github.io/website/>

docs/bit-docs/website.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@page website The Website
2+
3+
**This** is the bit-docs website. See also the <a href="about.html">About page</a>.

docs/outline.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
bit-docs
2+
receives
3+
finder
4+
generate
5+
processor
6+
7+
options
8+
dependencies
9+
10+
11+
bit-docs-generate-html
12+
options
13+
html
14+
"minifyBuild": false,
15+
"dest": "./gh-pages"
16+
parent
17+
18+
provides
19+
generate
20+
tags
21+
templateRender
22+
23+
receives
24+
html
25+
26+
modules
27+
bit-docs-generate-html/build/renderer
28+
bit-docs-generate-html/build/static_dist
29+
30+
bit-docs-finder
31+
options
32+
glob
33+
34+
provides
35+
finder

package.json

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
{
2+
"name": "bit-docs-website",
3+
"version": "0.0.1",
4+
"description": "Website that documents bit-docs",
5+
"keywords": [
6+
"documentation",
7+
"donejs",
8+
"website"
9+
],
10+
"homepage": "https://github.com/bit-docs/website#readme",
11+
"bugs": {
12+
"url": "https://github.com/bit-docs/website/issues"
13+
},
14+
"license": "MIT",
15+
"author": "Bitovi",
16+
"main": "index.js",
17+
"repository": {
18+
"type": "git",
19+
"url": "git+https://github.com/bit-docs/website.git"
20+
},
21+
"scripts": {
22+
"bit-docs": "bit-docs -d",
23+
"gh-pages": "gh-pages -d gh-pages",
24+
"test": "echo \"Error: no test specified\" && exit 1"
25+
},
26+
"devDependencies": {
27+
"bit-docs": "^0.0.7",
28+
"bit-docs-glob-finder": "^0.0.5",
29+
"bit-docs-dev": "^0.0.3",
30+
"bit-docs-js": "^0.0.6",
31+
"bit-docs-process-mustache": "^0.0.1",
32+
"bit-docs-generate-html": "^0.4.3",
33+
"gh-pages": "^0.12.0"
34+
},
35+
"bit-docs": {
36+
"dependencies": {
37+
"bit-docs-glob-finder": "^0.0.5",
38+
"bit-docs-dev": "^0.0.3",
39+
"bit-docs-js": "^0.0.6",
40+
"bit-docs-generate-html": "^0.4.3"
41+
},
42+
"glob": {
43+
"pattern": "{node_modules,docs}/bit-docs*/**/*.{js,md}",
44+
"ignore": [
45+
"node_modules/bit-docs/lib/configure/**/*",
46+
"node_modules/bit-docs*/node_modules/**/*"
47+
]
48+
},
49+
"parent": "BitDocs",
50+
"minifyBuild": false,
51+
"dest": "./gh-pages"
52+
}
53+
}

0 commit comments

Comments
 (0)