Review and update code blocks in Shift_docs

Inbibo / shift_docs

Shift Documentation

0 stars 0 forks source link

Review and update code blocks in Shift_docs #60

Closed juliavisserinbibo closed 2 months ago

juliavisserinbibo commented 2 months ago

At the moment, the webpage does not format multilined code blocks properly. We found a workaround to display multiline blocks, however they won't be highlighted.

<pre>
  <code style="white-space: pre">
    some
    multiline
    code
    block
  </code>
</pre>

For the time being, we should use this format.

juliavisserinbibo commented 2 months ago

After opening the PR there are some things to take into account

To make the code look less cramped, we need to add margin and padding to the code block
"<" and ">" symbols cannot be written raw. They need to be substituted by &lt and &gt respectively.

Example:

<pre><code style="white-space: pre; margin: 20px 0; padding: 10px; box-sizing: border-box;">from shift.core import files
workflow, catalog_manifest = files.openBatchWorkflow("&ltpath_to_your_workflow_file&gt")
</code></pre>