Skip to content

Commit 0d8e511

Browse files
authored
Merge pull request #3357 from NativeScript/etabakov/public-cli-docs
docs: prepare md files for docs.nativescript.org
2 parents 2c5fc10 + 57d173b commit 0d8e511

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+324
-69
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ test-reports.xml
3535

3636
npm-debug.log
3737
node_modules
38+
3839
docs/html
40+
docs-cli
3941

4042
!test-scripts/*.js

Gruntfile.js

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,29 @@ module.exports = function (grunt) {
125125
"!lib/common/test-scripts/**/*",
126126
"!lib/common/scripts/**/*",
127127
"*.tgz"]
128+
},
129+
template: {
130+
'process-markdowns': {
131+
options: {
132+
data: {
133+
"isJekyll": true,
134+
"isHtml": true,
135+
"isConsole": true,
136+
"isWindows": true,
137+
"isMacOS": true,
138+
"isLinux": true,
139+
"formatListOfNames": () => {},
140+
"constants": ""
141+
}
142+
},
143+
files: [{
144+
expand: true,
145+
cwd: "docs/man_pages/",
146+
src: "**/*.md",
147+
dest: "docs-cli/",
148+
ext: ".md"
149+
}]
150+
}
128151
}
129152
});
130153

@@ -133,6 +156,7 @@ module.exports = function (grunt) {
133156
grunt.loadNpmTasks("grunt-contrib-watch");
134157
grunt.loadNpmTasks("grunt-shell");
135158
grunt.loadNpmTasks("grunt-ts");
159+
grunt.loadNpmTasks("grunt-template");
136160

137161
grunt.registerTask("set_package_version", function (version) {
138162
var buildVersion = version !== undefined ? version : buildNumber;
@@ -183,4 +207,5 @@ module.exports = function (grunt) {
183207
grunt.registerTask("all", ["clean", "test", "lint"]);
184208
grunt.registerTask("rebuild", ["clean", "ts:devlib"]);
185209
grunt.registerTask("default", "ts:devlib");
210+
grunt.registerTask("docs-jekyll", ['template']);
186211
};

docs/build-jekyll-md.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/usr/bin/env bash
2+
set -e
3+
4+
rm -rf docs-cli
5+
npm install --ignore-scripts
6+
7+
grunt docs-jekyll

docs/man_pages/device/device-android.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
device android
1+
<% if (isJekyll) { %>---
2+
title: tns device android
3+
position: 1
4+
---<% } %>
5+
# tns device android
26
==========
37

48
Usage | Synopsis

docs/man_pages/device/device-ios.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
device ios
1+
<% if (isJekyll) { %>---
2+
title: tns device ios
3+
position: 2
4+
---<% } %>
5+
# tns device ios
26
==========
37

48
Usage | Synopsis

docs/man_pages/device/device-list-applications.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
device list-applications
1+
<% if (isJekyll) { %>---
2+
title: tns device list-applications
3+
position: 3
4+
---<% } %>
5+
# tns device list-applications
26
==========
37

48
Usage | Synopsis

docs/man_pages/device/device-log.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
device log
1+
<% if (isJekyll) { %>---
2+
title: tns device log
3+
position: 4
4+
---<% } %>
5+
# tns device log
26
==========
37

48
Usage | Synopsis

docs/man_pages/device/device-run.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
device run
1+
<% if (isJekyll) { %>---
2+
title: tns device run
3+
position: 5
4+
---<% } %>
5+
# tns device run
26
==========
37

48
Usage | Synopsis

docs/man_pages/device/device.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
device
1+
<% if (isJekyll) { %>---
2+
title: tns device
3+
position: 6
4+
---<% } %>
5+
# tns device
26
==========
37

48
Usage | Synopsis

docs/man_pages/general/autocomplete-disable.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
autocomplete disable
1+
<% if (isJekyll) { %>---
2+
title: tns autocomplete disable
3+
position: 1
4+
---<% } %>
5+
# tns autocomplete disable
26
==========
37

48
Usage | Synopsis

0 commit comments

Comments
 (0)