Skip to content

Commit a4f66fb

Browse files
committed
docs: introduction
1 parent e92416b commit a4f66fb

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

introduction.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -108,12 +108,12 @@ The easiest and straight-forward way to create your customized template is to cl
108108

109109
Here is the list of the six main blank templates depending on the coding language preferences.
110110

111-
- Plain JavaScript template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank)
112-
- TypeScript template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ts](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ts)
113-
- Angular template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ng](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ng)
114-
- Vue.js template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-vue](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-vue)
115-
- React template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-react](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-react)
116-
- Svelte template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-svelte](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-svelte)
111+
- [Blank Plain JavaScript template](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank)
112+
- [Blank TypeScript template](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ts)
113+
- [Blank Angular template](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ng)
114+
- [Blank Vue.js template](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-vue)
115+
- [Blank React template](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-react)
116+
- [Blank Svelte template](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-svelte)
117117

118118
Creating your template is as simple as cloning the wanted template repository and modifying the source code to satisfy your business logic.
119119

@@ -130,15 +130,9 @@ ns run android
130130
// start making code changes
131131
```
132132

133-
## Versioning Scheme
134-
135-
`@nativescript/core` does not follow Semantic Versioning. Major framework releases are released every six months (~March and ~September), while minor and patch releases may be released as often as every week. Patch releases should never contain breaking changes, however minor, and major releases can. We strive to note any breaking changes in the Changelogs, to make upgrades as easy as possible.
136-
137-
When referencing the `@nativescript/core` package, you should use a fixed version constraint such as `7.0.11`, or alternatively `~7.0.11` to allow installing patch updates.
138-
139-
## Guidelines
133+
#### Guidelines
140134

141-
### Template Structure Guidelines
135+
##### Template Structure Guidelines
142136

143137
- Create folders named for the feature area they represent. Each featured area should be placed in a separate folder in the template's folder structure.
144138

@@ -148,7 +142,7 @@ When referencing the `@nativescript/core` package, you should use a fixed versio
148142

149143
- Avoid putting all of your app template's code in a root folder named _app_. When the actual app is created from the template, all of the template's code will indeed go inside a root **app** folder, but you MUST NOT define this folder in the hierarchy of your template; otherwise, the `ns create` CLI command will not function properly.
150144

151-
### Package.json Guidelines
145+
##### Package.json Guidelines
152146

153147
- Place a `package.json` file in the root folder of your app template.
154148
Note this is not the actual root package.json of the generated mobile app – it is only used by the `ns create` CLI command upon app creation. Do not expect that everything you place in your package.json will be transferred to the actual package.json file. Notably `scripts` property content is removed. However, if you provide preinstall / postinstall scripts, they will be executed before getting removed. You can use this mechanism to generate/move settings files to the root folder of the generated app and generate actual "scripts" content for the resulting app package.json – see [copying settings files](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/preinstall.js) and [generating `scripts` commands on-the-fly](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/postinstall.js) for concrete examples.
@@ -208,18 +202,18 @@ When referencing the `@nativescript/core` package, you should use a fixed versio
208202
- `category-general` - will show the template under the "General" tab in the ["Templates" page](https://market.nativescript.org/?tab=templates). This is the general or basic category, used to describe "generic" functionality.
209203
- `category-healthcare` - will show the template under the "Healthcare" tab in the ["Templates" page](https://market.nativescript.org/?tab=templates). This is a special category, used to describe a template with functionality related to the healthcare industry.
210204

211-
### Marketplace Guidelines
205+
##### Marketplace Guidelines
212206

213207
- Publish your app template to npm (https://www.npmjs.com/) using **ns-template-[custom-template-name-goes-here]-ts** format for the npm package name.
214208

215209
- Provide a screenshot preview to be used in a future NativeScript Marketplace integration under **tools/assets/marketplace.png** in your app template folder structure.
216-
Check [tools/postinstall.js](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/postinstall.js) that implements a mechanism for removing the "tools" infrastructure folder from the generated app.
210+
Check [tools/postinstall.js [NOT FOUND]](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/postinstall.js) that implements a mechanism for removing the "tools" infrastructure folder from the generated app.
217211

218212
- Provide correct `repository` property value in the root package.json file of your app template (see the "Package.json guidelines" section above for additional package.json requirements).
219213

220214
- [Read more](https://github.com/NativeScript/marketplace-feedback/blob/master/docs/template-submission.md) how to submit your app template to [NativeScript Marketplace](https://market.nativescript.org).
221215

222-
### Styling Guidelines
216+
##### Styling Guidelines
223217

224218
- Consider using the [NativeScript core theme](https://github.com/NativeScript/theme) for styling your app template.
225219

@@ -347,8 +341,14 @@ NavigationButton {
347341
/* Place any CSS rules you want to apply only on iOS here */
348342
```
349343

350-
### More Guidelines
344+
##### More Guidelines
351345

352346
- [Read JavaScript App Template Style Guide](https://github.com/NativeScript/nativescript-starter-kits-utils/blob/master/docs/style-guide-app-template.md)
353347

354348
- [Read Angular App Template Style Guide](https://github.com/NativeScript/nativescript-starter-kits-utils/blob/master/docs/style-guide-app-template-ng.md)
349+
350+
## Versioning Scheme
351+
352+
`@nativescript/core` does not follow Semantic Versioning. Major framework releases are released every six months (~March and ~September), while minor and patch releases may be released as often as every week. Patch releases should never contain breaking changes, however minor, and major releases can. We strive to note any breaking changes in the Changelogs, to make upgrades as easy as possible.
353+
354+
When referencing the `@nativescript/core` package, you should use a fixed version constraint such as `7.0.11`, or alternatively `~7.0.11` to allow installing patch updates.

0 commit comments

Comments
 (0)