readme/doc

nativescript-community · Oct 24, 2023 · 083f891 · 083f891
1 parent 61c6f58
commit 083f891
Show file tree

Hide file tree

Showing 13 changed files with 1,292 additions and 642 deletions.
diff --git a/README.md b/README.md
@@ -1,81 +1,4 @@
-<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
-[](#demos-and-development)
-
-## Demos and Development
-
-
-### Repo Setup
-
-The repo uses submodules. If you did not clone with ` --recursive` then you need to call
-```
-git submodule update --init
-```
-
-The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
-
-To develop and test:
-if you use `yarn` then run `yarn`
-if you use `pnpm` then run `pnpm i`
-
-**Interactive Menu:**
-
-To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
-
-### Build
-
-```bash
-npm run build.all
-```
-
-### Demos
-
-```bash
-npm run demo.[ng|react|svelte|vue].[ios|android]
-
-npm run demo.svelte.ios # Example
-```
-
-
-[](#contributing)
-
-## Contributing
-
-### Update repo 
-
-You can update the repo files quite easily
-
-First update the submodules
-
-```bash
-npm run update
-```
-
-Then commit the changes
-Then update common files
-
-```bash
-npm run sync
-```
-Then you can run `yarn|pnpm`, commit changed files if any
-
-### Update readme 
-```bash
-npm run readme
-```
-
-### Update doc 
-```bash
-npm run doc
-```
-
-### Publish
-
-The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
-Simply run 
-```shell
-npm run publish
-```
-<br><br><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
+<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️-->
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
@@ -123,9 +46,15 @@ npm run publish
  * [Vue](#vue)
  * [Examples](#examples)
 * [Demos and Development](#demos-and-development)
- * [Setup](#setup)
+ * [Repo Setup](#repo-setup)
  * [Build](#build)
  * [Demos](#demos)
+* [Contributing](#contributing)
+ * [Update repo ](#update-repo-)
+ * [Update readme ](#update-readme-)
+ * [Update doc ](#update-doc-)
+ * [Publish](#publish)
+ * [modifying submodules](#modifying-submodules)
 * [Questions](#questions)
 
 
@@ -185,30 +114,133 @@ export function openFilePicker(params: FilePickerOptions): Promise<{ files: stri
 ## Demos and Development
 
 
-### Setup
+### Repo Setup
+
+The repo uses submodules. If you did not clone with ` --recursive` then you need to call
+```
+git submodule update --init
+```
+
+The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
+
+To develop and test:
+if you use `yarn` then run `yarn`
+if you use `pnpm` then run `pnpm i`
+
+**Interactive Menu:**
+
+To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
+
+### Build
+
+```bash
+npm run build.all
+```
+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`
+
+### Demos
+
+```bash
+npm run demo.[ng|react|svelte|vue].[ios|android]
+
+npm run demo.svelte.ios # Example
+```
+
+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]`
+Instead you work in `demo-snippets/[ng|react|svelte|vue]`
+You can start from the `install.ts` of each flavor to see how to register new demos 
+
+
+[](#contributing)
+
+
+[](#contributing)
+
+## Contributing
+
+### Update repo 
+
+You can update the repo files quite easily
+
+First update the submodules
+
+```bash
+npm run update
+```
 
-To run the demos, you must clone this repo **recursively**.
+Then commit the changes
+Then update common files
 
+```bash
+npm run sync
 ```
-git clone https://github.com/@nativescript-community/ui-document-picker.git --recursive
+Then you can run `yarn|pnpm`, commit changed files if any
+
+### Update readme 
+```bash
+npm run readme
 ```
 
-**Install Dependencies:**
+### Update doc 
 ```bash
-npm i # or 'yarn install' or 'pnpm install'
+npm run doc
+```
+
+### Publish
+
+The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
+Simply run 
+```shell
+npm run publish
+```
+
+### modifying submodules
+
+The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
+One easy solution is t modify `~/.gitconfig` and add
+```
+[url "ssh://[email protected]/"]
+ pushInsteadOf = https://github.com/
 ```
 
+
+[](#questions)
+
+
+[](#questions)
+
+## Questions
+
+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).
+
+[](#demos-and-development)
+
+## Demos and Development
+
+
+### Repo Setup
+
+The repo uses submodules. If you did not clone with ` --recursive` then you need to call
+```
+git submodule update --init
+```
+
+The package manager used to install and link dependencies must be `pnpm` or `yarn`. `npm` wont work.
+
+To develop and test:
+if you use `yarn` then run `yarn`
+if you use `pnpm` then run `pnpm i`
+
 **Interactive Menu:**
 
 To start the interactive menu, run `npm start` (or `yarn start` or `pnpm start`). This will list all of the commonly used scripts.
 
 ### Build
 
 ```bash
-npm run build
-
-npm run build.angular # or for Angular
+npm run build.all
 ```
+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`
 
 ### Demos
 
@@ -217,9 +249,60 @@ npm run demo.[ng|react|svelte|vue].[ios|android]
 
 npm run demo.svelte.ios # Example
 ```
+
+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]`
+Instead you work in `demo-snippets/[ng|react|svelte|vue]`
+You can start from the `install.ts` of each flavor to see how to register new demos 
+
 
-[](#questions)
+[](#contributing)
 
+## Contributing
+
+### Update repo 
+
+You can update the repo files quite easily
+
+First update the submodules
+
+```bash
+npm run update
+```
+
+Then commit the changes
+Then update common files
+
+```bash
+npm run sync
+```
+Then you can run `yarn|pnpm`, commit changed files if any
+
+### Update readme 
+```bash
+npm run readme
+```
+
+### Update doc 
+```bash
+npm run doc
+```
+
+### Publish
+
+The publishing is completely handled by `lerna` (you can add `-- --bump major` to force a major release)
+Simply run 
+```shell
+npm run publish
+```
+
+### modifying submodules
+
+The repo uses https:// for submodules which means you won't be able to push directly into the submodules.
+One easy solution is t modify `~/.gitconfig` and add
+```
+[url "ssh://[email protected]/"]
+ pushInsteadOf = https://github.com/
+```
 
 [](#questions)
 

diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css
@@ -1,20 +1,22 @@
 :root {
- --light-hl-0: #001080;
- --dark-hl-0: #9CDCFE;
+ --light-hl-0: #AF00DB;
+ --dark-hl-0: #C586C0;
  --light-hl-1: #000000;
  --dark-hl-1: #D4D4D4;
- --light-hl-2: #008000;
- --dark-hl-2: #6A9955;
- --light-hl-3: #AF00DB;
- --dark-hl-3: #C586C0;
- --light-hl-4: #0000FF;
- --dark-hl-4: #569CD6;
- --light-hl-5: #267F99;
- --dark-hl-5: #4EC9B0;
+ --light-hl-2: #0000FF;
+ --dark-hl-2: #569CD6;
+ --light-hl-3: #267F99;
+ --dark-hl-3: #4EC9B0;
+ --light-hl-4: #001080;
+ --dark-hl-4: #9CDCFE;
+ --light-hl-5: #008000;
+ --dark-hl-5: #6A9955;
  --light-hl-6: #795E26;
  --dark-hl-6: #DCDCAA;
- --light-hl-7: #000000;
- --dark-hl-7: #C8C8C8;
+ --light-hl-7: #A31515;
+ --dark-hl-7: #CE9178;
+ --light-hl-8: #000000;
+ --dark-hl-8: #C8C8C8;
  --light-code-background: #FFFFFF;
  --dark-code-background: #1E1E1E;
 }
@@ -28,6 +30,7 @@
  --hl-5: var(--light-hl-5);
  --hl-6: var(--light-hl-6);
  --hl-7: var(--light-hl-7);
+ --hl-8: var(--light-hl-8);
  --code-background: var(--light-code-background);
 } }
 
@@ -40,6 +43,7 @@
  --hl-5: var(--dark-hl-5);
  --hl-6: var(--dark-hl-6);
  --hl-7: var(--dark-hl-7);
+ --hl-8: var(--dark-hl-8);
  --code-background: var(--dark-code-background);
 } }
 
@@ -52,6 +56,7 @@
  --hl-5: var(--light-hl-5);
  --hl-6: var(--light-hl-6);
  --hl-7: var(--light-hl-7);
+ --hl-8: var(--light-hl-8);
  --code-background: var(--light-code-background);
 }
 
@@ -64,6 +69,7 @@
  --hl-5: var(--dark-hl-5);
  --hl-6: var(--dark-hl-6);
  --hl-7: var(--dark-hl-7);
+ --hl-8: var(--dark-hl-8);
  --code-background: var(--dark-code-background);
 }
 
@@ -75,4 +81,5 @@
 .hl-5 { color: var(--hl-5); }
 .hl-6 { color: var(--hl-6); }
 .hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
 pre, code { background: var(--code-background); }
diff --git a/docs/assets/main.js b/docs/assets/main.js
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js