knight/datahub
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[s] data-literate README documentation slightly updated

Browse Source
This commit is contained in:
Leonardo Rocha
2022-02-23 17:15:20 +01:00
parent 6cfa61dffd
commit ce24e488d1
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
examples/data-literate/README.md
View File

@@ -14,10 +14,11 @@ yarn #install packages
yarn dev # start app in dev mode yarn dev # start app in dev mode
``` ```
You should see the demo portal running with the example dataset provided: You should see the demo portal running with the example dataset provided in `http://localhost:3000/demo`
For the moment there is no root path and each markdown file will have it's own path (route) for the generated html code.
TODO TODO
### Use your own dataset ### Use your own dataset
You can try it out with your own data literate setups: You can try it out with your own data literate setups:
@@ -50,6 +51,8 @@ Results will be in `out/` subfolder.
To test you will need to run a local webserver in the folder (just opening the relevant file in your browser won't work): To test you will need to run a local webserver in the folder (just opening the relevant file in your browser won't work):
Here we do this with another (non nodejs based) server to show that the static site works. Python3 as a really useful simple http server that one can use here:
``` ```
cd out cd out
python3 -m http.server python3 -m http.server