Skip to content

Commit 0a43d4b

Browse files
farfromrefugfarfromrefug
committed
readme/doc
1 parent 36ad151 commit 0a43d4b

File tree

83 files changed

+15536
-252
lines changed

Some content is hidden

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

83 files changed

+15536
-252
lines changed

‎README.md‎

Lines changed: 173 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,4 @@
1-
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
2-
[](#demos-and-development)
3-
4-
## Demos and Development
5-
6-
7-
### Repo Setup
8-
9-
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
10-
```
11-
git submodule update --init
12-
```
13-
14-
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
15-
16-
To develop and test:
17-
if you use `yarn` then run `yarn`
18-
if you use `pnpm` then run `pnpm i`
19-
20-
**Interactive Menu:**
21-
22-
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
23-
24-
### Build
25-
26-
```bash
27-
npm run build.all
28-
```
29-
30-
### Demos
31-
32-
```bash
33-
npm run demo.[ng|react|svelte|vue].[ios|android]
34-
35-
npm run demo.svelte.ios # Example
36-
```
37-
38-
39-
[](#contributing)
40-
41-
## Contributing
42-
43-
### Update repo
44-
45-
You can update the repo files quite easily
46-
47-
First update the submodules
48-
49-
```bash
50-
npm run update
51-
```
52-
53-
Then commit the changes
54-
Then update common files
55-
56-
```bash
57-
npm run sync
58-
```
59-
Then you can run `yarn|pnpm`, commit changed files if any
60-
61-
### Update readme
62-
```bash
63-
npm run readme
64-
```
65-
66-
### Update doc
67-
```bash
68-
npm run doc
69-
```
70-
71-
### Publish
72-
73-
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
74-
Simply run
75-
```shell
76-
npm run publish
77-
```
78-
<br><br><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
1+
<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
792
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
803
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
814
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -171,9 +94,15 @@ npm run publish
17194
* [hasFineLocationPermission / requestFineLocationPermission](#hasfinelocationpermission--requestfinelocationpermission)
17295
* [Using marker images from the internet](#using-marker-images-from-the-internet)
17396
* [Demos and Development](#demos-and-development)
174-
* [Setup](#setup)
97+
* [Repo Setup](#repo-setup)
17598
* [Build](#build)
17699
* [Demos](#demos)
100+
* [Contributing](#contributing)
101+
* [Update repo ](#update-repo-)
102+
* [Update readme ](#update-readme-)
103+
* [Update doc ](#update-doc-)
104+
* [Publish](#publish)
105+
* [modifying submodules](#modifying-submodules)
177106
* [Questions](#questions)
178107

179108

@@ -1176,18 +1105,123 @@ the domain. Google for iOS ATS for detailed options, but for a quick test you ca
11761105
## Demos and Development
11771106
11781107
1179-
### Setup
1108+
### Repo Setup
1109+
1110+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
1111+
```
1112+
git submodule update --init
1113+
```
1114+
1115+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
1116+
1117+
To develop and test:
1118+
if you use `yarn` then run `yarn`
1119+
if you use `pnpm` then run `pnpm i`
1120+
1121+
**Interactive Menu:**
1122+
1123+
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
11801124
1181-
To run the demos, you must clone this repo **recursively**.
1125+
### Build
11821126
1127+
```bash
1128+
npm run build.all
11831129
```
1184-
git clone https://github.com/@nativescript-community/ui-mapbox.git --recursive
1130+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
1131+
1132+
### Demos
1133+
1134+
```bash
1135+
npm run demo.[ng|react|svelte|vue].[ios|android]
1136+
1137+
npm run demo.svelte.ios # Example
11851138
```
11861139
1187-
**Install Dependencies:**
1140+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
1141+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
1142+
You can start from the `install.ts` of each flavor to see how to register new demos
1143+
1144+
1145+
[](#contributing)
1146+
1147+
1148+
[](#contributing)
1149+
1150+
## Contributing
1151+
1152+
### Update repo
1153+
1154+
You can update the repo files quite easily
1155+
1156+
First update the submodules
1157+
1158+
```bash
1159+
npm run update
1160+
```
1161+
1162+
Then commit the changes
1163+
Then update common files
1164+
1165+
```bash
1166+
npm run sync
1167+
```
1168+
Then you can run `yarn|pnpm`, commit changed files if any
1169+
1170+
### Update readme
1171+
```bash
1172+
npm run readme
1173+
```
1174+
1175+
### Update doc
11881176
```bash
1189-
npm i # or 'yarn install' or 'pnpm install'
1177+
npm run doc
1178+
```
1179+
1180+
### Publish
1181+
1182+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
1183+
Simply run
1184+
```shell
1185+
npm run publish
1186+
```
1187+
1188+
### modifying submodules
1189+
1190+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
1191+
One easy solution is t modify `~/.gitconfig` and add
1192+
```
1193+
[url "ssh://git@github.com/"]
1194+
pushInsteadOf = https://github.com/
1195+
```
1196+
1197+
1198+
[](#questions)
1199+
1200+
1201+
[](#questions)
1202+
1203+
## Questions
1204+
1205+
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
1206+
1207+
1208+
[](#demos-and-development)
1209+
1210+
## Demos and Development
1211+
1212+
1213+
### Repo Setup
1214+
1215+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
11901216
```
1217+
git submodule update --init
1218+
```
1219+
1220+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
1221+
1222+
To develop and test:
1223+
if you use `yarn` then run `yarn`
1224+
if you use `pnpm` then run `pnpm i`
11911225
11921226
**Interactive Menu:**
11931227
@@ -1196,10 +1230,9 @@ To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`)
11961230
### Build
11971231
11981232
```bash
1199-
npm run build
1200-
1201-
npm run build.angular # or for Angular
1233+
npm run build.all
12021234
```
1235+
WARNING: it seems `yarn build.all` wont always work (not finding binaries in `node_modules/.bin`) which is why the doc explicitly uses `npm run`
12031236
12041237
### Demos
12051238
@@ -1208,12 +1241,63 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
12081241

12091242
npm run demo.svelte.ios # Example
12101243
```
1244+
1245+
Demo setup is a bit special in the sense that if you want to modify/add demos you dont work directly in `demo-[ng|react|svelte|vue]`
1246+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
1247+
You can start from the `install.ts` of each flavor to see how to register new demos
1248+
12111249
1212-
[](#questions)
1250+
[](#contributing)
12131251
1252+
## Contributing
1253+
1254+
### Update repo
1255+
1256+
You can update the repo files quite easily
1257+
1258+
First update the submodules
1259+
1260+
```bash
1261+
npm run update
1262+
```
1263+
1264+
Then commit the changes
1265+
Then update common files
1266+
1267+
```bash
1268+
npm run sync
1269+
```
1270+
Then you can run `yarn|pnpm`, commit changed files if any
1271+
1272+
### Update readme
1273+
```bash
1274+
npm run readme
1275+
```
1276+
1277+
### Update doc
1278+
```bash
1279+
npm run doc
1280+
```
1281+
1282+
### Publish
1283+
1284+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
1285+
Simply run
1286+
```shell
1287+
npm run publish
1288+
```
1289+
1290+
### modifying submodules
1291+
1292+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
1293+
One easy solution is t modify `~/.gitconfig` and add
1294+
```
1295+
[url "ssh://git@github.com/"]
1296+
pushInsteadOf = https://github.com/
1297+
```
12141298
12151299
[](#questions)
12161300
12171301
## Questions
12181302
1219-
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).
1303+
If you have any questions/issues/comments please feel free to create an issue or start a conversation in the [NativeScript Community Discord](https://nativescript.org/discord).

‎docs/assets/highlight.css‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
:root {
2-
--light-hl-0: #001080;
3-
--dark-hl-0: #9CDCFE;
4-
--light-hl-1: #000000;
5-
--dark-hl-1: #D4D4D4;
6-
--light-hl-2: #008000;
7-
--dark-hl-2: #6A9955;
8-
--light-hl-3: #800000;
9-
--dark-hl-3: #808080;
10-
--light-hl-4: #800000;
11-
--dark-hl-4: #569CD6;
12-
--light-hl-5: #FF0000;
13-
--dark-hl-5: #9CDCFE;
14-
--light-hl-6: #0000FF;
15-
--dark-hl-6: #CE9178;
16-
--light-hl-7: #AF00DB;
17-
--dark-hl-7: #C586C0;
18-
--light-hl-8: #A31515;
19-
--dark-hl-8: #CE9178;
20-
--light-hl-9: #795E26;
21-
--dark-hl-9: #DCDCAA;
22-
--light-hl-10: #0000FF;
23-
--dark-hl-10: #569CD6;
24-
--light-hl-11: #CD3131;
25-
--dark-hl-11: #F44747;
2+
--light-hl-0: #000000;
3+
--dark-hl-0: #D4D4D4;
4+
--light-hl-1: #800000;
5+
--dark-hl-1: #808080;
6+
--light-hl-2: #800000;
7+
--dark-hl-2: #569CD6;
8+
--light-hl-3: #E50000;
9+
--dark-hl-3: #9CDCFE;
10+
--light-hl-4: #0000FF;
11+
--dark-hl-4: #CE9178;
12+
--light-hl-5: #AF00DB;
13+
--dark-hl-5: #C586C0;
14+
--light-hl-6: #001080;
15+
--dark-hl-6: #9CDCFE;
16+
--light-hl-7: #A31515;
17+
--dark-hl-7: #CE9178;
18+
--light-hl-8: #795E26;
19+
--dark-hl-8: #DCDCAA;
20+
--light-hl-9: #0000FF;
21+
--dark-hl-9: #569CD6;
22+
--light-hl-10: #CD3131;
23+
--dark-hl-10: #F44747;
24+
--light-hl-11: #008000;
25+
--dark-hl-11: #6A9955;
2626
--light-hl-12: #098658;
2727
--dark-hl-12: #B5CEA8;
2828
--light-hl-13: #267F99;

‎docs/assets/main.js‎

Lines changed: 55 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/assets/style.css‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -483,10 +483,9 @@ blockquote {
483483
.has-menu .col-menu {
484484
visibility: visible;
485485
transform: translate(0, 0);
486-
display: grid;
487-
align-items: center;
488-
grid-template-rows: auto 1fr;
489-
grid-gap: 1.5rem;
486+
display: flex;
487+
flex-direction: column;
488+
gap: 1.5rem;
490489
max-height: 100vh;
491490
padding: 1rem 2rem;
492491
}
@@ -911,7 +910,7 @@ a.tsd-index-link {
911910
margin-right: 0.8rem;
912911
}
913912

914-
@media (min-width: 1024px) {
913+
@media (min-width: 1025px) {
915914
.col-content {
916915
margin: 2rem auto;
917916
}

0 commit comments

Comments
 (0)