<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="/default.xsl"?>
<fr:tree xmlns:fr="http://www.forester-notes.org" xmlns:html="http://www.w3.org/1999/xhtml" xmlns:xml="http://www.w3.org/XML/1998/namespace" root="false" base-url="/">
  <fr:frontmatter>
    <fr:authors />
    <fr:uri>https://offshore.pressed.press/MD/</fr:uri>
    <fr:display-uri>MD</fr:display-uri>
    <fr:route>/MD/</fr:route>
    <fr:title text="Markdown shownotes">Markdown shownotes</fr:title>
    <fr:taxon>reference</fr:taxon>
    <fr:meta name="external">https://commonmark.org/</fr:meta>
  </fr:frontmatter>
  <fr:mainmatter>
    <html:p>offshore accepts commonmark markdown content for shownotes. It will be translated to proper HTML format on <fr:link href="/GEN/" title="Feed generation" uri="https://offshore.pressed.press/GEN/" display-uri="GEN" type="local">feed generation</fr:link>. HTML shownotes from external feed will be converted into markdown on <fr:link href="/IMP/" title="Importer" uri="https://offshore.pressed.press/IMP/" display-uri="IMP" type="local">import</fr:link> with <fr:link href="https://github.com/matthewwithanm/python-markdownify" type="external"><html:code>markdownify</html:code></fr:link>.</html:p>
    <html:p>offshore supports the following list of markdown syntax.</html:p>
    <html:table style="border-collapse: collapse;">
  
  <html:tr>
    
  <html:th>Syntax</html:th>

    
  <html:th>Format</html:th>

  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>*Italic*</html:code> or <html:code>_Italic_</html:code>
  </html:td>
    <html:td style="padding: .5em 0;"><html:em>Italic</html:em></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>**Bold**</html:code> or <html:code>__Bold__</html:code>
  </html:td>
    <html:td style="padding: .5em 0;"><html:strong>Bold</html:strong></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code># Heading 1</html:code> or <html:pre><![CDATA[Heading 1 
=========]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;"><fr:tree show-metadata="false"><fr:frontmatter><fr:authors /><fr:title text="Heading 1">Heading 1</fr:title></fr:frontmatter><fr:mainmatter /></fr:tree></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>## Heading 2</html:code> or <html:pre><![CDATA[Heading 2 
---------]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;">Heading 2</html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code><![CDATA[ [Hyperlink](https://example.com)]]></html:code> or <html:pre><![CDATA[[Hyperlink][1]
...
[1]: https://example.com]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;">
    <fr:link href="https://example.com/" type="external">Hyperlink</fr:link>
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code><![CDATA[ ![Image](https://offshore.pressed.press/favicon-16x16.png)]]></html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:img src="https://offshore.pressed.press/favicon-16x16.png" />
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>&gt; Blockquote</html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:code>Blockquote</html:code>
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;"><html:pre><![CDATA[* List or - List
* List    - List
* List    - List]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;"><html:ul><html:li>List</html:li><html:li>List</html:li><html:li>List</html:li></html:ul></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;"><html:pre><![CDATA[1. One    or 1) One
2. Two       2) Two
3. Three     3) Three]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;"><html:ol><html:li>One</html:li><html:li>Two</html:li><html:li>Three</html:li></html:ol></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>---</html:code> or <html:code>***</html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:hr />
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>`Inline code` with backticks</html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:code>Inline code</html:code> with backticks
  </html:td>
  </html:tr>

  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;"><html:pre><![CDATA[```
# code block
print '3'
print 'home'
```]]></html:pre></html:td>
    <html:td style="padding: .5em 0;"><html:pre><![CDATA[# code block
print '3'
print 'home']]></html:pre></html:td>
  </html:tr>

  </html:table>
  </fr:mainmatter>
  <fr:backmatter>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="References">References</fr:title>
      </fr:frontmatter>
      <fr:mainmatter />
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Context">Context</fr:title>
      </fr:frontmatter>
      <fr:mainmatter>
        <fr:tree show-metadata="true" expanded="false" toc="false" numbered="false">
          <fr:frontmatter>
            <fr:authors />
            <fr:uri>https://offshore.pressed.press/WUI3/</fr:uri>
            <fr:display-uri>WUI3</fr:display-uri>
            <fr:route>/WUI3/</fr:route>
            <fr:title text="Episode editor">Episode editor</fr:title>
          </fr:frontmatter>
          <fr:mainmatter>
            <html:img src="https://git.sr.ht/~lamons/offshore/blob/main/docs/0.5.2_ee.jpeg" />
            <html:p>Episode editor can be launched from the “New episode” button on the top navigation, or when editing an existing episode.</html:p>
            <html:p>User can enter all metadata of an episode in this page.</html:p>
            <fr:tree show-metadata="false">
              <fr:frontmatter>
                <fr:authors />
                <fr:uri>https://offshore.pressed.press/MD/</fr:uri>
                <fr:display-uri>MD</fr:display-uri>
                <fr:route>/MD/</fr:route>
                <fr:title text="Markdown shownotes">Markdown shownotes</fr:title>
                <fr:taxon>reference</fr:taxon>
                <fr:meta name="external">https://commonmark.org/</fr:meta>
              </fr:frontmatter>
              <fr:mainmatter>
                <html:p>offshore accepts commonmark markdown content for shownotes. It will be translated to proper HTML format on <fr:link href="/GEN/" title="Feed generation" uri="https://offshore.pressed.press/GEN/" display-uri="GEN" type="local">feed generation</fr:link>. HTML shownotes from external feed will be converted into markdown on <fr:link href="/IMP/" title="Importer" uri="https://offshore.pressed.press/IMP/" display-uri="IMP" type="local">import</fr:link> with <fr:link href="https://github.com/matthewwithanm/python-markdownify" type="external"><html:code>markdownify</html:code></fr:link>.</html:p>
                <html:p>offshore supports the following list of markdown syntax.</html:p>
                <html:table style="border-collapse: collapse;">
  
  <html:tr>
    
  <html:th>Syntax</html:th>

    
  <html:th>Format</html:th>

  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>*Italic*</html:code> or <html:code>_Italic_</html:code>
  </html:td>
    <html:td style="padding: .5em 0;"><html:em>Italic</html:em></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>**Bold**</html:code> or <html:code>__Bold__</html:code>
  </html:td>
    <html:td style="padding: .5em 0;"><html:strong>Bold</html:strong></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code># Heading 1</html:code> or <html:pre><![CDATA[Heading 1 
=========]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;"><fr:tree show-metadata="false"><fr:frontmatter><fr:authors /><fr:title text="Heading 1">Heading 1</fr:title></fr:frontmatter><fr:mainmatter /></fr:tree></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>## Heading 2</html:code> or <html:pre><![CDATA[Heading 2 
---------]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;">Heading 2</html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code><![CDATA[ [Hyperlink](https://example.com)]]></html:code> or <html:pre><![CDATA[[Hyperlink][1]
...
[1]: https://example.com]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;">
    <fr:link href="https://example.com/" type="external">Hyperlink</fr:link>
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code><![CDATA[ ![Image](https://offshore.pressed.press/favicon-16x16.png)]]></html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:img src="https://offshore.pressed.press/favicon-16x16.png" />
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>&gt; Blockquote</html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:code>Blockquote</html:code>
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;"><html:pre><![CDATA[* List or - List
* List    - List
* List    - List]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;"><html:ul><html:li>List</html:li><html:li>List</html:li><html:li>List</html:li></html:ul></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;"><html:pre><![CDATA[1. One    or 1) One
2. Two       2) Two
3. Three     3) Three]]></html:pre>
  </html:td>
    <html:td style="padding: .5em 0;"><html:ol><html:li>One</html:li><html:li>Two</html:li><html:li>Three</html:li></html:ol></html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>---</html:code> or <html:code>***</html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:hr />
  </html:td>
  </html:tr>

  
  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;">
    <html:code>`Inline code` with backticks</html:code>
  </html:td>
    <html:td style="padding: .5em 0;">
    <html:code>Inline code</html:code> with backticks
  </html:td>
  </html:tr>

  <html:tr style="border-bottom: 1px solid color(srgb 0 0 0 / 0.19);border-top: 1px solid color(srgb 0 0 0 / 0.19);">
    <html:td style="padding: .5em .5em .5em 0;"><html:pre><![CDATA[```
# code block
print '3'
print 'home'
```]]></html:pre></html:td>
    <html:td style="padding: .5em 0;"><html:pre><![CDATA[# code block
print '3'
print 'home']]></html:pre></html:td>
  </html:tr>

  </html:table>
              </fr:mainmatter>
            </fr:tree>
            <html:p>Audio URL is <fr:link href="/CK/" title="Check" uri="https://offshore.pressed.press/CK/" display-uri="CK" type="local">checked</fr:link> for format and reachability on save. Episode artworks are also <fr:link href="/FT3/" title="Image validation" uri="https://offshore.pressed.press/FT3/" display-uri="FT3" type="local">validated</fr:link> when newly set or changed.</html:p>
            <fr:tree show-metadata="false">
              <fr:frontmatter>
                <fr:authors />
                <fr:uri>https://offshore.pressed.press/GUID/</fr:uri>
                <fr:display-uri>GUID</fr:display-uri>
                <fr:route>/GUID/</fr:route>
                <fr:title text="GUID">GUID</fr:title>
                <fr:taxon>Feature</fr:taxon>
              </fr:frontmatter>
              <fr:mainmatter>
                <html:p>Globally unique identifiers (GUID) are unique identifiers for episodes. An episode’s GUID must remain unique and unchanged for it to be identified correctly. If an episode’s GUID is moodified in the feed, it will be recognized as a different episode.</html:p>
                <html:p>offshore generates uuidv5 GUIDs that fully compliant with the <fr:link href="/PCNS/" title="Podcast Namespace" uri="https://offshore.pressed.press/PCNS/" display-uri="PCNS" type="local">podcast namespace</fr:link> for each episodes created in offshore. This value is write-once and cannot be changed in anyway. For imported show, the GUID is inherited from the original feed and won’t be touched. All GUIDs are protected by <fr:link href="/LK/" title="&lt;slug&gt;.lock.json" uri="https://offshore.pressed.press/LK/" display-uri="LK" type="local"><html:code>&lt;slug&gt;.lock.json</html:code></fr:link>.</html:p>
              </fr:mainmatter>
            </fr:tree>
          </fr:mainmatter>
        </fr:tree>
      </fr:mainmatter>
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Backlinks">Backlinks</fr:title>
      </fr:frontmatter>
      <fr:mainmatter />
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Related">Related</fr:title>
      </fr:frontmatter>
      <fr:mainmatter>
        <fr:tree show-metadata="true" expanded="false" toc="false" numbered="false">
          <fr:frontmatter>
            <fr:authors />
            <fr:uri>https://offshore.pressed.press/GEN/</fr:uri>
            <fr:display-uri>GEN</fr:display-uri>
            <fr:route>/GEN/</fr:route>
            <fr:title text="Feed generation">Feed generation</fr:title>
            <fr:taxon>Feature</fr:taxon>
          </fr:frontmatter>
          <fr:mainmatter>
            <html:p>Based on the show metadata, offshore aim to generate podcast feed accurately and intelligently. offshore generates feed following <fr:link href="https://www.rssboard.org/rss-specification" type="external">RSS 2.0</fr:link> specification, and incorporates <fr:link href="/APNS/" title="Apple Podcasts namespace" uri="https://offshore.pressed.press/APNS/" display-uri="APNS" type="local">Reference <fr:contextual-number uri="https://offshore.pressed.press/APNS/" display-uri="APNS" /></fr:link> and <fr:link href="/PCNS/" title="Podcast Namespace" uri="https://offshore.pressed.press/PCNS/" display-uri="PCNS" type="local">Reference <fr:contextual-number uri="https://offshore.pressed.press/PCNS/" display-uri="PCNS" /></fr:link> at the same time.</html:p>
            <html:p>offshore use <fr:link href="https://markdown-it-py.readthedocs.io/en/latest/" type="external"><html:code>markdown-it-py</html:code></fr:link> to translate markdown shownotes into HTML.</html:p>
            <html:p>The generated feed can be downloaded right away, or <fr:link href="/FT1/" title="Set consistent feed output path per show" uri="https://offshore.pressed.press/FT1/" display-uri="FT1" type="local">saved to a custom path</fr:link> configurable in the <fr:link href="/WUI2/" title="Show settings" uri="https://offshore.pressed.press/WUI2/" display-uri="WUI2" type="local">show settings</fr:link>.</html:p>
          </fr:mainmatter>
        </fr:tree>
        <fr:tree show-metadata="true" expanded="false" toc="false" numbered="false">
          <fr:frontmatter>
            <fr:authors />
            <fr:uri>https://offshore.pressed.press/IMP/</fr:uri>
            <fr:display-uri>IMP</fr:display-uri>
            <fr:route>/IMP/</fr:route>
            <fr:title text="Importer">Importer</fr:title>
            <fr:taxon>feature</fr:taxon>
          </fr:frontmatter>
          <fr:mainmatter />
        </fr:tree>
      </fr:mainmatter>
    </fr:tree>
    <fr:tree show-metadata="false" hidden-when-empty="true">
      <fr:frontmatter>
        <fr:authors />
        <fr:title text="Contributions">Contributions</fr:title>
      </fr:frontmatter>
      <fr:mainmatter />
    </fr:tree>
  </fr:backmatter>
</fr:tree>
