Add readme
You may add customized readme file to your script. The linked Markdown file will be available by clicking icon on the ribbon panel. The readme file will appear inside of the panel on the right side.
- Result
- Short sample
- Full sample
Following code will search for the help file in the particular package (e.g., Compute
).
Your script header (w/ package file)
//meta.help: Compute/readme.md
Following code will search for the help file in your Datagrok's Home folder.
Your script header (w/ personal file)
//meta.help: readme.md
https://public.datagrok.ai/scripts
//name: Data stats
//language: javascript
//tags: demo
//input: dataframe inputDf {caption: Input dataframe; viewer: Grid(); category: Input data}
//output: dataframe outputDf {caption: Output dataframe; viewer: Line chart(block: 50) | Scatter plot(block: 50) | Statistics(block: 100); category: Stats}
//editor: Compute:RichFunctionViewEditor
//meta.runOnOpen: true
//meta.runOnInput: true
outputDf = inputDf.clone();