8000 Added initial documentation · saknarak/nativescript-vue@2085f86 · GitHub
[go: up one dir, main page]
Skip to content

Commit 2085f86

Browse files
rigor789rigor789
committed
Added initial documentation
1 parent dcffe75 commit 2085f86

File tree

5 files changed

+169
-0
lines changed

5 files changed

+169
-0
lines changed

‎docs/.nojekyll

Whitespace-only changes.

‎docs/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: Introduction
3+
---
4+
# Introduction
5+
6+
## What is [NativeScript](https://www.nativescript.org/)?
7+
8+
NativeScript is an open source framework for building truly native mobile application using JavaScript.
9+
10+
## What is [Vue.js](https://vuejs.org/)?
11+
12+
Vue (pronounced /vjuː/, like view) is a progressive framework for building user interfaces. The core library is focused on the view layer only, and is very easy to pick up and integrate with other libraries or existing projects.
13+
14+
## What is NativeScript-Vue?
15+
16+
NativeScript-Vue is a NativeScript Plugin which allows you to use Vue.js to craft your mobile application.
17+
18+
If you have used Vue.js before you will feel at home with NativeScript-Vue.
19+
20+
## Why would you use this?
21+
22+
If you are in the position where you want to create mobile applications, and just found about NativeScript, but you don't want to use xml to write your layouts and pure javascript to handle all the logic, and you don't want to use Angular either, instead you want an easy to learn and fun way to write your applications, you might want to consider giving this a try, Vue.js is very enjoyable to work with.
23+
24+
25+
# Ready to get started?
26+
<a router-link="/installation" class="docute-button docute-button-success">
27+
Go to Installation
28+
</a>

‎docs/_toc.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
- [Introduction](/)
2+
- <span>Development</span>
3+
- [Installation](/installation)
4+
- [Quick Start](/installation)
5+
- <span>Elements</span>
6+
- <small>Layout</small>
7+
- [AbsolueLayout](/elements/layout/absolute-layout)
8+
- [DockLayout](/elements/layout/dock-layout)
9+
- [GridLayout](/elements/layout/grid-layout)
10+
- [StackLayout](/elements/layout/stack-layout)
11+
- [WrapLayout](/elements/layout/wrap-layout)
12+
- <small>Components</small>
13+
- [Button](/elements/components/button)
14+
- [Label](/elements/components/label)
15+
- [TextField](/elements/components/text-field)

‎docs/index.html

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=0"/>
7+
<title>NativeScript Vue Documentation</title>
8+
<link rel="stylesheet" href="https://unpkg.com/docute@3/dist/docute.css">
9+
10+
<style>
11+
@import url('https://fonts.googleapis.com/css?family=Roboto+Mono');
12+
13+
.page, .main {
14+
max-width: 100vw;
15+
}
16+
17+
.announcement {
18+
margin-top: 2em;
19+
border-top: 1px solid #e2e2e2;
20+
}
21+
22+
.logo {
23+
width: 100%;
24+
padding: 1em;
25+
}
26+
27+
.logo img {
28+
width: 100%;
29+
}
30+
31+
.logo h1 {
32+
text-align: center;
33+
margin: 0;
34+
color: #99a9bf;
35+
font-family: 'Roboto Mono', monospace;
36+
}
37+
38+
.sidebar span {
39+
padding-left: 20px;
40+
}
41+
42+
.sidebar small {
43+
color: #99a9bf;
44+
padding-left: 20px;
45+
font-size: 14px;
46+
line-height: 36px;
47+
}
48+
49+
.sidebar ul ul {
50+
padding-left: 20px;
51+
}
52+
53+
.content {
54+
margin-bottom: 50vh;
55+
}
56+
57+
.header .header-container, .no-sidebar .header {
58+
max-width: 100vw;
59+
}
60+
61+
::-webkit-scrollbar-track {
62+
background-color: #F5F5F5;
63+
}
64+
65+
::-webkit-scrollbar {
66+
width: 3px;
67+
background-color: #F5F5F5;
68+
}
69+
70+
::-webkit-scrollbar-thumb {
71+
background: rgba(0, 0, 0, 0.1);
72+
}
73+
</style>
74+
</head>
75+
<body>
76+
<div id="app"></div>
77+
<script src="https://unpkg.com/docute@3/dist/docute.js"></script>
78+
<script>
79+
docute.init({
80+
debug: true,
81+
82+
nav: [
83+
{
84+
title: 'Docs',
85+
path: '/',
86+
},
87+
{
88+
title: 'Roadmap',
89+
path: 'https://trello.com/b/mOdP0SHD/nativescript-vue-roadmap',
90+
},
91+
],
92+
93+
icons: [
94+
{
95+
icon: 'github',
96+
label: 'Contribute on GitHub',
97+
link: 'https://github.com/rigor789/nativescript-vue',
98+
},
99+
],
100+
101+
toc: './_toc.md',
102+
103+
plugins: [
104+
({ registerComponent }) => {
105+
registerComponent('sidebar:start', {
106+
template: `
107+
<div class="logo">
108+
<img src="https://raw.githubusercontent.com/rigor789/nativescript-vue/master/logo.png"/>
109+
110+
<h1>{N}-Vue</h1>
111+
</div>
112+
`,
113+
})
114+
}
115+
],
116+
})
117+
</script>
118+
</body>
119+
</html>

‎docs/installation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Installation
2+
3+
This is how you do it: `install everything`
4+
5+
## Foo
6+
7+
## Bar

0 commit comments

Comments
 (0)
0