improved way of displaying docs link (#1799)

* improved the way of displaying the doc links

* fix: check whether docs-link exists

Co-authored-by: Harsh Khandeparkar <34770591+HarshKhandeparkar@users.noreply.github.com>
Co-authored-by: Jeffrey Warren <jeff@unterbahn.com>
This commit is contained in:
Vivek Singh
2021-02-07 02:35:02 +05:30
committed by GitHub
parent d340a78aab
commit f7ca35af23

View File

@@ -25,6 +25,9 @@ function DefaultHtmlStepUi(_sequencer, options) {
if (step.options && step.options.description)
step.description = step.options.description;
let stepDocsLink = '';
if (step.moduleInfo) stepDocsLink = step.moduleInfo['docs-link'] || '';
step.ui = // Basic UI markup for the step
'\
<div class="container-fluid step-container">\
@@ -48,7 +51,7 @@ function DefaultHtmlStepUi(_sequencer, options) {
<div class="row step">\
<div class="col-md-4 details container-fluid">\
<div class="cal collapse in"><p>' +
'<a href="https://github.com/publiclab/image-sequencer/blob/main/docs/MODULES.md#' + step.name + '-module">' + (step.description || '') + '</a>' +
'<a href="' + stepDocsLink + '">' + (step.description || '') + '</a>' +
'</p></div>\
</div>\
<div class="col-md-8 cal collapse in step-column">\