<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/content/features/markdown-content-negotiation.md - fork/static-web-server @ allow-symlink</title>
<meta name="description" content="docs/content/features/markdown-content-negotiation.md in fork/static-web-server at allow-symlink.">
<meta property="og:title" content="docs/content/features/markdown-content-negotiation.md - fork/static-web-server @ allow-symlink">
<meta property="og:description" content="docs/content/features/markdown-content-negotiation.md in fork/static-web-server at allow-symlink.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="allow-symlink" data-tip="4414610fe1b0370ff0ac415e9367548840584710">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/static-web-server</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/static-web-server</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Matthias Schoettle</span><span class="commit-message" data-commit="dd43d06551fcf853e0012381c76af5b832d23b57">refactor: format check support Markdown files via mdformat (#597)</span><span class="snapshot-sha sha" data-commit="dd43d06551fcf853e0012381c76af5b832d23b57">dd43d06</span><time datetime="2025-12-07T04:40:21-05:00" title="2025-12-07 04:40:21 -0500">2025-12-07</time></p>
<header class="topbar"><details class="switcher"><summary>allow-symlink</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/static-web-server/ref/allow-symlink/">allow-symlink</a><a class="all" href="/fork/static-web-server/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/static-web-server/">static-web-server</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/">docs</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/content/">content</a> / <a href="/fork/static-web-server/ref/allow-symlink/tree/docs/content/features/">features</a> / <span class="cur">markdown-content-negotiation.md</span></nav>
<span class="view-stats"><span>3.9 KiB</span><span>126 lines</span></span><span class="actions"><a class="raw" href="/fork/static-web-server/raw/5100038ed52db13aaef58592e013c70adf2d541c/docs/content/features/markdown-content-negotiation.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Markdown Content Negotiation</h1>
<p><strong><code>SWS</code></strong> provides an optional content negotiation feature that serves markdown files when clients explicitly request them via the <code>Accept: text/markdown</code> HTTP header.</p>
<p>This feature enables serving the raw markdown source of your documentation or content alongside the rendered HTML versions, allowing clients to choose their preferred format.</p>
<p>The HTTP methods supported are <code>GET</code> and <code>HEAD</code>.</p>
<p>This feature is disabled by default and can be controlled by the boolean <code>--accept-markdown</code> option or the equivalent <a href="/fork/static-web-server/ref/allow-symlink/blob/docs/content/configuration/environment-variables.md#server_accept_markdown">SERVER_ACCEPT_MARKDOWN</a> env.</p>
<h2>How it works</h2>
<p>When a client sends a request with the <code>Accept: text/markdown</code> header, SWS will search for markdown variants in the following order:</p>
<ol>
<li><code>path.md</code> - Direct markdown file</li>
<li><code>path.html.md</code> - Markdown source file</li>
<li><code>path/index.html.md</code> - Directory index markdown source</li>
</ol>
<p>If a markdown variant is found, it will be served with the <code>Content-Type: text/markdown; charset=utf-8</code> header. If no markdown variant exists, the request falls back to normal static file handling.</p>
<p><strong>Important</strong>: The feature only activates for the explicit <code>Accept: text/markdown</code> header. Wildcard headers like <code>Accept: text/*</code> or <code>Accept: */*</code> will not trigger markdown content negotiation.</p>
<h2>Usage examples</h2>
<h3>Basic usage</h3>
<p>Start the server with markdown content negotiation enabled:</p>
<pre class="language-bash"><a-f>static-web-server</a-f> <a-co>--root</a-co> ./public <a-co>--accept-markdown</a-co></pre>
<p>Request a markdown file:</p>
<pre class="language-bash"><a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;Accept: text/markdown&quot;</a-s> http://localhost:8080/article
<a-c># Returns: article.md if it exists</a-c></pre>
<h3>With environment variable</h3>
<pre class="language-bash"><a-k>export</a-k> <a-pr>SERVER_ACCEPT_MARKDOWN</a-pr>=true
<a-f>static-web-server</a-f> <a-co>--root</a-co> ./public</pre>
<h3>Configuration file</h3>
<pre class="language-toml"><a-p>[</a-p><a-pr>general</a-pr><a-p>]</a-p>
<a-pr>root</a-pr> <a-o>=</a-o> <a-s>&quot;./public&quot;</a-s>
<a-pr>accept-markdown</a-pr> <a-o>=</a-o> <a-co>true</a-co></pre>
<h2>Use cases</h2>
<h3>LLM-friendly content with llms.txt</h3>
<p>This feature is the perfect companion for the <a href="https://llmstxt.org/">llms.txt standard</a>, which recommends that websites provide clean markdown versions of their pages for Large Language Models (LLMs) to consume.</p>
<p>According to the llms.txt standard, pages should provide markdown versions at the same URL with <code>.md</code> appended (or <code>index.html.md</code> for URLs without file names). With SWS's markdown content negotiation, LLMs and AI agents can request these markdown versions using the <code>Accept: text/markdown</code> header:</p>
<pre class="language-bash"><a-c># LLM requesting markdown version</a-c>
<a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;Accept: text/markdown&quot;</a-s> https://example.com/docs/api
<a-c># Returns: docs/api.html.md if it exists</a-c>

<a-c># Directory index</a-c>
<a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;Accept: text/markdown&quot;</a-s> https://example.com/docs/
<a-c># Returns: docs/index.html.md if it exists</a-c></pre>
<p>This approach is superior to traditional <code>.md</code> URL suffixes because:</p>
<ul>
<li>Uses standard HTTP content negotiation</li>
<li>Same URL serves both HTML (browsers) and Markdown (LLMs)</li>
<li>No need for separate URL structures or redirects</li>
<li>Follows REST principles for resource representation</li>
</ul>
<h3>Documentation sites</h3>
<p>Serve both HTML and markdown versions of your documentation:</p>
<pre>docs/
├── article.html       # Rendered version
└── article.html.md    # Markdown source
</pre>
<p>Browsers get the HTML version, while API clients or tools can request the markdown source:</p>
<pre class="language-bash"><a-c># Browser request (default)</a-c>
<a-f>curl</a-f> http://localhost:8080/article
<a-c># Returns: article.html</a-c>

<a-c># Request markdown source</a-c>
<a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;Accept: text/markdown&quot;</a-s> http://localhost:8080/article
<a-c># Returns: article.html.md</a-c></pre>
<h3>API responses</h3>
<p>Allow your API clients to request content in markdown format:</p>
<pre class="language-javascript"><a-f>fetch</a-f><a-p>(</a-p><a-s>&#39;/documentation&#39;</a-s><a-p>,</a-p> <a-p>{</a-p>
  <a-pr>headers</a-pr>: <a-p>{</a-p> <a-s>&#39;Accept&#39;</a-s>: <a-s>&#39;text/markdown&#39;</a-s> <a-p>}</a-p>
<a-p>})</a-p>
<a-p>.</a-p><a-f>then</a-f><a-p>(</a-p><a-v>response</a-v> <a-o>=&gt;</a-o> <a-v>response</a-v><a-p>.</a-p><a-f>text</a-f><a-p>())</a-p>
<a-p>.</a-p><a-f>then</a-f><a-p>(</a-p><a-v>markdown</a-v> <a-o>=&gt;</a-o> <a-v>console</a-v><a-p>.</a-p><a-f>log</a-f><a-p>(</a-p><a-v>markdown</a-v><a-p>));</a-p></pre>
<h3>Content management</h3>
<p>Serve markdown files for editing tools while providing HTML for end users:</p>
<pre class="language-bash"><a-c># Editor fetching source</a-c>
<a-f>curl</a-f> <a-co>-H</a-co> <a-s>&quot;Accept: text/markdown&quot;</a-s> http://localhost:8080/blog/post
<a-c># Returns: blog/post.md</a-c>

<a-c># Regular browser visit</a-c>
<a-f>curl</a-f> http://localhost:8080/blog/post
<a-c># Returns: blog/post.html or blog/post/index.html</a-c></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Markdown Content Negotiation</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">**`SWS`** provides an optional content negotiation feature that serves markdown files when clients explicitly request them via the `Accept: text/markdown` HTTP header.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text">This feature enables serving the raw markdown source of your documentation or content alongside the rendered HTML versions, allowing clients to choose their preferred format.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text">The HTTP methods supported are `GET` and `HEAD`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">This feature is disabled by default and can be controlled by the boolean `--accept-markdown` option or the equivalent [SERVER_ACCEPT_MARKDOWN](../configuration/environment-variables.md#server_accept_markdown) env.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>##</a-p> <a-tt>How it works</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">When a client sends a request with the `Accept: text/markdown` header, SWS will search for markdown variants in the following order:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>1. </a-p>`path.md` - Direct markdown file</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>2. </a-p>`path.html.md` - Markdown source file</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>3. </a-p>`path/index.html.md` - Directory index markdown source</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>If a markdown variant is found, it will be served with the `Content-Type: text/markdown; charset=utf-8` header. If no markdown variant exists, the request falls back to normal static file handling.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>**Important**: The feature only activates for the explicit `Accept: text/markdown` header. Wildcard headers like `Accept: text/*` or `Accept: */*` will not trigger markdown content negotiation.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>## </a-p><a-tt>Usage examples</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>### </a-p><a-tt>Basic usage</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>Start the server with markdown content negotiation enabled:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>static-web-server --root ./public --accept-markdown</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>Request a markdown file:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>curl -H &quot;Accept: text/markdown&quot; http://localhost:8080/article</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p># Returns: article.md if it exists</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"><a-p>### </a-p><a-tt>With environment variable</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>export SERVER_ACCEPT_MARKDOWN=true</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>static-web-server --root ./public</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>### </a-p><a-tt>Configuration file</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>```</a-p><a-tl>toml</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>[</a-p><a-pr>general</a-pr><a-p>]</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>root </a-p><a-o>=</a-o><a-p> </a-p><a-s>&quot;./public&quot;</a-s></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>accept-markdown </a-p><a-o>=</a-o><a-p> </a-p><a-co>true</a-co></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>## </a-p><a-tt>Use cases</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>### </a-p><a-tt>LLM-friendly content with llms.txt</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>This feature is the perfect companion for the [llms.txt standard](https://llmstxt.org/), which recommends that websites provide clean markdown versions of their pages for Large Language Models (LLMs) to consume.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>According to the llms.txt standard, pages should provide markdown versions at the same URL with `.md` appended (or `index.html.md` for URLs without file names). With SWS&#39;s markdown content negotiation, LLMs and AI agents can request these markdown versions using the `Accept: text/markdown` header:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p># LLM requesting markdown version</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"><a-p>curl -H &quot;Accept: text/markdown&quot; https://example.com/docs/api</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p># Returns: docs/api.html.md if it exists</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p># Directory index</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>curl -H &quot;Accept: text/markdown&quot; https://example.com/docs/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p># Returns: docs/index.html.md if it exists</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>This approach is superior to traditional `.md` URL suffixes because:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>- Uses standard HTTP content negotiation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>- Same URL serves both HTML (browsers) and Markdown (LLMs)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"><a-p>- No need for separate URL structures or redirects</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>- Follows REST principles for resource representation</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>### </a-p><a-tt>Documentation sites</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>Serve both HTML and markdown versions of your documentation:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>docs/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"><a-p>├── article.html       # Rendered version</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-p>└── article.html.md    # Markdown source</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-p>Browsers get the HTML version, while API clients or tools can request the markdown source:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p># Browser request (default)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>curl http://localhost:8080/article</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p># Returns: article.html</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-p># Request markdown source</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>curl -H &quot;Accept: text/markdown&quot; http://localhost:8080/article</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p># Returns: article.html.md</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>### </a-p><a-tt>API responses</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"><a-p>Allow your API clients to request content in markdown format:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>```</a-p><a-tl>javascript</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>fetch(</a-p><a-s>&#39;/documentation&#39;</a-s><a-p>, {</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-p>  </a-p><a-pr>headers</a-pr><a-p>: { </a-p><a-s>&#39;Accept&#39;</a-s><a-p>: </a-p><a-s>&#39;text/markdown&#39;</a-s><a-p> }</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"><a-p>})</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>.</a-p><a-f>then</a-f><a-p>(</a-p><a-v>response</a-v><a-p> </a-p><a-o>=&gt;</a-o><a-p> </a-p><a-v>response</a-v><a-p>.</a-p><a-f>text</a-f><a-p>())</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>.</a-p><a-f>then</a-f><a-p>(</a-p><a-v>markdown</a-v><a-p> </a-p><a-o>=&gt;</a-o><a-p> </a-p><a-v>console</a-v><a-p>.</a-p><a-f>log</a-f><a-p>(</a-p><a-v>markdown</a-v><a-p>));</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>### </a-p><a-tt>Content management</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>Serve markdown files for editing tools while providing HTML for end users:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>```</a-p><a-tl>sh</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p># Editor fetching source</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"><a-p>curl -H &quot;Accept: text/markdown&quot; http://localhost:8080/blog/post</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p># Returns: blog/post.md</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p># Regular browser visit</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>curl http://localhost:8080/blog/post</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"><a-p># Returns: blog/post.html or blog/post/index.html</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
