Skip to content

Commit 40f2842

Browse files
committed
readme/doc
1 parent 660abf7 commit 40f2842

File tree

5 files changed

+205
-23
lines changed

5 files changed

+205
-23
lines changed

README.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -441,6 +441,103 @@ One easy solution is t modify `~/.gitconfig` and add
441441
[](#questions)
442442

443443

444+
[](#questions)
445+
446+
## Questions
447+
448+
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).
449+
450+
[](#demos-and-development)
451+
452+
## Demos and Development
453+
454+
455+
### Repo Setup
456+
457+
The repo uses submodules. If you did not clone with ` --recursive` then you need to call
458+
```
459+
git submodule update --init
460+
```
461+
462+
The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
463+
464+
To develop and test:
465+
if you use `yarn` then run `yarn`
466+
if you use `pnpm` then run `pnpm i`
467+
468+
**Interactive Menu:**
469+
470+
To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
471+
472+
### Build
473+
474+
```bash
475+
npm run build.all
476+
```
477+
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`
478+
479+
### Demos
480+
481+
```bash
482+
npm run demo.[ng|react|svelte|vue].[ios|android]
483+
484+
npm run demo.svelte.ios # Example
485+
```
486+
487+
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]`
488+
Instead you work in `demo-snippets/[ng|react|svelte|vue]`
489+
You can start from the `install.ts` of each flavor to see how to register new demos
490+
491+
492+
[](#contributing)
493+
494+
## Contributing
495+
496+
### Update repo
497+
498+
You can update the repo files quite easily
499+
500+
First update the submodules
501+
502+
```bash
503+
npm run update
504+
```
505+
506+
Then commit the changes
507+
Then update common files
508+
509+
```bash
510+
npm run sync
511+
```
512+
Then you can run `yarn|pnpm`, commit changed files if any
513+
514+
### Update readme
515+
```bash
516+
npm run readme
517+
```
518+
519+
### Update doc
520+
```bash
521+
npm run doc
522+
```
523+
524+
### Publish
525+
526+
The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
527+
Simply run
528+
```shell
529+
npm run publish
530+
```
531+
532+
### modifying submodules
533+
534+
The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
535+
One easy solution is t modify `~/.gitconfig` and add
536+
```
537+
[url "ssh://[email protected]/"]
538+
pushInsteadOf = https://github.com/
539+
```
540+
444541
[](#questions)
445542

446543
## Questions

docs/assets/highlight.css

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
--dark-hl-6: #B5CEA8;
1616
--light-hl-7: #A31515;
1717
--dark-hl-7: #CE9178;
18-
--light-hl-8: #AF00DB;
19-
--dark-hl-8: #C586C0;
20-
--light-hl-9: #795E26;
21-
--dark-hl-9: #DCDCAA;
18+
--light-hl-8: #795E26;
19+
--dark-hl-8: #DCDCAA;
20+
--light-hl-9: #AF00DB;
21+
--dark-hl-9: #C586C0;
2222
--light-hl-10: #000000;
2323
--dark-hl-10: #C8C8C8;
2424
--light-hl-11: #800000;

docs/assets/main.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)