jprdonnelly/nebula.js
1
0
Fork 0
mirror of https://github.com/qlik-oss/nebula.js.git synced 2025-12-19 09:48:18 -05:00
Code Issues Projects Releases Wiki Activity

docs: linking nebula docs (#909)

Browse Source 
* docs: linking nebula docs
* docs: apply suggestions from code review
* Update docs/installation.md

Co-authored-by: Li Kang <kkllpaul7766@gmail.com>
Co-authored-by: Christian Veinfors <christian.veinfors@gmail.com>
This commit is contained in:
Johan Lahti
2022-09-05 16:35:08 +02:00
committed by GitHub
parent 3fd20458dc
commit b657294183
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/installation.md
View File

@@ -60,3 +60,16 @@ You should only use these during the development phase of your project, never in
```html
<script src="https://cdn.jsdelivr.net/npm/@nebula.js/stardust@0.6.0/dist/stardust.dev.js" crossorigin></script>
```
## Linking nebula packages to your own repository
When you use nebula.js as a dependency in your project, and you want to edit or debug the nebula.js source code, you can use either `npm link` or `yarn link` to accomplish this.
### Linking nebula when using `nebula serve`
With `npm`: Before using `nebula serve` to serve your project's files, you must run `npm link` in the folder: `nebula.js/commands/serve` and use it in your own repo by running `npm link @nebula.js/cli-serve` (run this in your own repo).
To include source maps, so you can easier debug the nebula.js code, you should also run `yarn build:dev` in the `nebula.js/commands/serve` folder.
With `yarn`: Same as for `npm` but replace `npm` with `yarn` in the commands above.
In your browser's debugging tool you should now be able to see the nebula.js source code and to add breakpoints inside of the nebula.js files.