File tree 8 files changed +75
-4
lines changed
vuepress-plugin-versioning
8 files changed +75
-4
lines changed Original file line number Diff line number Diff line change 1
1
# titanium-docgen
2
2
3
- This is a copy of the JavaScript files in https://github.com/appcelerator/titanium_mobile/tree/master/apidoc to make it available as a standalone package.
3
+ > Generates Titanium API documentation in different formats
4
+
5
+ ## Installation
6
+
7
+ ``` sh
8
+ npm i titanium-docgen -D
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```
14
+ node docgen [--addon-docs <PATH_TO_YAML_FILES] [--css <CSS_FILE>] [--format <EXPORT_FORMAT>] [--output <OUTPUT_DIRECTORY>] <PATH_TO_YAML_FILES>
15
+ ```
16
+
17
+ For a description of each option. run ` docgen --help ` .
18
+
19
+ ## Supported formats
20
+
21
+ | Format | Description |
22
+ | --- | --- |
23
+ | ` addon ` | |
24
+ | ` changes ` | |
25
+ | ` html ` | HTML files for the official docs at https://docs.appcelerator.com |
26
+ | ` jsca ` | [ JSCA] ( https://docs.appcelerator.com/platform/latest/#!/guide/JSCA_1.0_Specification ) content assist metadata |
27
+ | ` jsduck ` | https://github.com/senchalabs/jsduck |
28
+ | ` json ` | JSON metadata file |
29
+ | ` json-raw ` | Same as ` json ` , but with no pre-rendered markdown |
30
+ | ` modulehtml ` | |
31
+ | ` parity ` | |
32
+ | ` solr ` | Solr search index |
33
+ | ` typescript ` | TypeScript type definition file |
Original file line number Diff line number Diff line change 1
1
{
2
2
"name" : " titanium-docgen" ,
3
3
"version" : " 0.0.0" ,
4
- "description" : " Various generators to format Titanium API documentation" ,
4
+ "description" : " Generates Titanium API documentation in different formats " ,
5
5
"main" : " index.js" ,
6
6
"scripts" : {
7
7
"test" : " echo \" Error: no test specified\" && exit 1"
8
8
},
9
- "author" : " Axway Appcelerator" ,
10
- "license" : " Apache-2.0" ,
11
9
"bin" : {
12
10
"docgen" : " bin/docgen.js"
13
11
},
12
+ "keywords" : [
13
+ " titanium" ,
14
+ " docgen" ,
15
+ " documentation"
16
+ " docs"
17
+ ],
18
+ "author" : " Axway Appcelerator" ,
19
+ "license" : " Apache-2.0" ,
20
+ "repository" : {
21
+ "type" : " git" ,
22
+ "url" : " https://github.com/appcelerator/docs-devkit.git" ,
23
+ "directory" : " packages/titanium-docgen"
24
+ },
14
25
"dependencies" : {
15
26
"colors" : " ^1.3.3" ,
16
27
"ejs" : " ^2.6.2" ,
Original file line number Diff line number Diff line change
1
+ # vuepres-plugin-apidocs
2
+
3
+ > VuePress plugin to render API reference documentation
4
+
5
+ 📖 View the [ Documentation] ( https://titanium-docs-devkit.netlify.com/guide/api-docs.html ) .
Original file line number Diff line number Diff line change 14
14
],
15
15
"author" : " Axway Appcelerator" ,
16
16
"license" : " Apache-2.0" ,
17
+ "repository" : {
18
+ "type" : " git" ,
19
+ "url" : " https://github.com/appcelerator/docs-devkit.git" ,
20
+ "directory" : " packages/vuepress/vuepress-plugin-apidocs"
21
+ },
17
22
"dependencies" : {
18
23
"@vuepress/shared-utils" : " ^1.0.2" ,
19
24
"axios" : " ^0.19.0" ,
Original file line number Diff line number Diff line change
1
+ # vuepres-plugin-versioning
2
+
3
+ > Versioning plugin for VuePress
4
+
5
+ 📖 View the [ Documentation] ( https://titanium-docs-devkit.netlify.com/guide/versioning.html ) .
Original file line number Diff line number Diff line change 14
14
],
15
15
"author" : " Axway Appcelerator" ,
16
16
"license" : " Apache-2.0" ,
17
+ "repository" : {
18
+ "type" : " git" ,
19
+ "url" : " https://github.com/appcelerator/docs-devkit.git" ,
20
+ "directory" : " packages/vuepress/vuepress-plugin-versioning"
21
+ },
17
22
"dependencies" : {
18
23
"@vuepress/shared-utils" : " ^1.0.2" ,
19
24
"fs-extra" : " ^8.1.0"
Original file line number Diff line number Diff line change
1
+ # vuepres-theme-titanium
2
+
3
+ > Supercharged version of the default theme for VuePress
4
+
5
+ 📖 View the [ Documentation] ( https://titanium-docs-devkit.netlify.com/theme/ ) .
Original file line number Diff line number Diff line change 8
8
},
9
9
"author" : " Axway Appcelerator" ,
10
10
"license" : " Apache-2.0" ,
11
+ "repository" : {
12
+ "type" : " git" ,
13
+ "url" : " https://github.com/appcelerator/docs-devkit.git" ,
14
+ "directory" : " packages/vuepress/vuepress-theme-titanium"
15
+ },
11
16
"dependencies" : {
12
17
"@vuepress/plugin-nprogress" : " ^1.0.2" ,
13
18
"@vuepress/plugin-search" : " ^1.0.2" ,
You can’t perform that action at this time.
0 commit comments