Add docsify to style markdowns and generate docs

This commit is contained in:
Atul R 2019-07-30 22:34:41 +02:00
parent 96f9999ee1
commit c3f2a676f8
4 changed files with 2304 additions and 29 deletions

0
extras/docs/.nojekyll Normal file
View File

42
extras/docs/index.html Normal file
View File

@ -0,0 +1,42 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title>
@nodegui/nodegui - A cross platform library to build native desktop apps.
</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta
name="description"
content="A cross platform library to build native desktop apps."
/>
<meta
name="viewport"
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
/>
<!-- <link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css" /> -->
<!-- <link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple.css"
/> -->
<link
rel="stylesheet"
href="https://cdn.jsdelivr.net/npm/docsify-themeable@0/dist/css/theme-simple-dark.css"
/>
</head>
<body>
<div id="app">Loading documentation...</div>
<script>
window.$docsify = {
name: "NodeGui",
repo: "https://github.com/nodegui/nodegui",
themeable: {
readyTransition: true, // default
responsiveTables: true // default
}
};
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/docsify-themeable@0"></script>
</body>
</html>

View File

@ -15,12 +15,13 @@
"license": "MIT",
"private": false,
"devDependencies": {
"@nodegui/test": "^0.0.10",
"@types/bindings": "^1.3.0",
"@types/lodash": "^4.14.130",
"@types/node": "^12.0.2",
"docsify-cli": "^4.3.0",
"prettier": "^1.17.1",
"typescript": "^3.4.5",
"@nodegui/test": "^0.0.10"
"typescript": "^3.4.5"
},
"scripts": {
"dev": "npm run build && qode dist/demo.js",
@ -29,15 +30,16 @@
"build:lib": "tsc",
"build:addon": "node-gyp -j 8 build",
"rebuild:addon": "node-gyp -j 8 rebuild",
"automoc": "node ./scripts/automoc.js"
"automoc": "node ./scripts/automoc.js",
"docs": "docsify serve ./extras/docs"
},
"peerDependencies": {
"@nodegui/test": "*"
},
"dependencies": {
"node-gyp": "^4.0.0",
"bindings": "^1.5.0",
"node-addon-api": "^1.6.3"
"node-addon-api": "^1.6.3",
"node-gyp": "^4.0.0"
},
"gypfile": true
}

2279
yarn.lock

File diff suppressed because it is too large Load Diff