<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Markdown Quickstart Template — LLVM 8 documentation</title> <link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" /> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/language_data.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Code Reviews with Phabricator" href="Phabricator.html" /> <link rel="prev" title="Sphinx Quickstart Template" href="SphinxQuickstartTemplate.html" /> <style type="text/css"> table.right { float: right; margin-left: 20px; } table.right td { border: 1px solid #ccc; } </style> </head><body> <div class="logo"> <a href="index.html"> <img src="_static/logo.png" alt="LLVM Logo" width="250" height="88"/></a> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="Phabricator.html" title="Code Reviews with Phabricator" accesskey="N">next</a> |</li> <li class="right" > <a href="SphinxQuickstartTemplate.html" title="Sphinx Quickstart Template" accesskey="P">previous</a> |</li> <li><a href="http://llvm.org/">LLVM Home</a> | </li> <li><a href="index.html">Documentation</a>»</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="body" role="main"> <div class="section" id="markdown-quickstart-template"> <h1>Markdown Quickstart Template<a class="headerlink" href="#markdown-quickstart-template" title="Permalink to this headline">¶</a></h1> <div class="section" id="introduction-and-quickstart"> <h2>Introduction and Quickstart<a class="headerlink" href="#introduction-and-quickstart" title="Permalink to this headline">¶</a></h2> <p>This document is meant to get you writing documentation as fast as possible even if you have no previous experience with Markdown. The goal is to take someone in the state of “I want to write documentation and get it added to LLVM’s docs” and turn that into useful documentation mailed to llvm-commits with as little nonsense as possible.</p> <p>You can find this document in . You should copy it, open the new file in your text editor, write your docs, and then send the new document to llvm-commits for review.</p> <p>Focus on <em>content</em>. It is easy to fix the Markdown syntax later if necessary, although Markdown tries to imitate common plain-text conventions so it should be quite natural. A basic knowledge of Markdown syntax is useful when writing the document, so the last ~half of this document (starting with <a class="reference external" href="#example-section">Example Section</a>) gives examples which should cover 99% of use cases.</p> <p>Let me say that again: focus on <em>content</em>. But if you really need to verify Sphinx’s output, see for information.</p> <p>Once you have finished with the content, please send the file to llvm-commits for review.</p> </div> <div class="section" id="guidelines"> <h2>Guidelines<a class="headerlink" href="#guidelines" title="Permalink to this headline">¶</a></h2> <p>Try to answer the following questions in your first section:</p> <ol class="simple"> <li>Why would I want to read this document?</li> <li>What should I know to be able to follow along with this document?</li> <li>What will I have learned by the end of this document?</li> </ol> <p>Common names for the first section are , , or .</p> <p>If possible, make your document a “how to”. Give it a name like the other “how to” documents. This format is usually the easiest for another person to understand and also the most useful.</p> <p>You generally should not be writing documentation other than a “how to” unless there is already a “how to” about your topic. The reason for this is that without a “how to” document to read first, it is difficult for a person to understand a more advanced document.</p> <p>Focus on content (yes, I had to say it again).</p> <p>The rest of this document shows example Markdown markup constructs that are meant to be read by you in your text editor after you have copied this file into a new file for the documentation you are about to write.</p> </div> <div class="section" id="example-section"> <h2>Example Section<a class="headerlink" href="#example-section" title="Permalink to this headline">¶</a></h2> <p>Your text can be <em>emphasized</em>, <strong>bold</strong>, or .</p> <p>Use blank lines to separate paragraphs.</p> <p>Headings (like just above) give your document its structure.</p> <div class="section" id="example-subsection"> <h3>Example Subsection<a class="headerlink" href="#example-subsection" title="Permalink to this headline">¶</a></h3> <p>Make a link <a class="reference external" href="http://llvm.org/">like this</a>. There is also a more sophisticated syntax which <a class="reference external" href="http://en.wikipedia.org/wiki/LLVM">can be more readable</a> for longer links since it disrupts the flow less. You can put the block pretty much anywhere later in the document.</p> <p>Lists can be made like this:</p> <ol class="simple"> <li>A list starting with will be automatically numbered.</li> <li>This is a second list element.<ol> <li>Use indentation to create nested lists.</li> </ol> </li> </ol> <p>You can also use unordered lists.</p> <ul class="simple"> <li>Stuff.<ul> <li>Deeper stuff.</li> </ul> </li> <li>More stuff.</li> </ul> <div class="section" id="example-subsubsection"> <h4>Example Subsubsection<a class="headerlink" href="#example-subsubsection" title="Permalink to this headline">¶</a></h4> <p>You can make blocks of code like this:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">int</span> <span class="n">main</span><span class="p">()</span> <span class="p">{</span> <span class="k">return</span> <span class="mi">0</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>As an extension to markdown, you can also specify a highlighter to use.</p> <div class="highlight-C++ notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span> <span class="nf">main</span><span class="p">()</span> <span class="p">{</span> <span class="k">return</span> <span class="mi">0</span><span class="p">;</span> <span class="p">}</span> </pre></div> </div> <p>For a shell session, use a code block.</p> <div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$</span> <span class="nb">echo</span> <span class="s2">"Goodbye cruel world!"</span> <span class="gp">$</span> rm -rf / </pre></div> </div> <p>If you need to show LLVM IR use the code block.</p> <div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i32</span> <span class="vg">@test1</span><span class="p">()</span> <span class="p">{</span> <span class="nl">entry:</span> <span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span> <span class="p">}</span> </pre></div> </div> <p>Some other common code blocks you might need are , , , and . If you need something beyond that, you can look at the <a class="reference external" href="http://pygments.org/docs/lexers/">full list</a> of supported code blocks.</p> <p>However, don’t waste time fiddling with syntax highlighting when you could be adding meaningful content. When in doubt, show preformatted text without any syntax highlighting like this:</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span> <span class="o">.</span> <span class="o">+</span><span class="p">:</span><span class="o">.</span> <span class="o">..</span><span class="p">::</span> <span class="p">::</span> <span class="o">.++</span><span class="p">:</span><span class="o">+</span><span class="p">::</span> <span class="p">::</span><span class="o">+</span><span class="p">:</span><span class="o">.</span><span class="p">:</span><span class="o">.</span> <span class="o">.</span><span class="p">:</span><span class="o">+</span> <span class="p">:</span> <span class="p">::</span><span class="o">.</span><span class="p">::</span><span class="o">..</span><span class="p">::</span> <span class="o">.+.</span> <span class="o">..</span><span class="p">:</span><span class="o">+</span> <span class="p">::</span> <span class="p">:</span> <span class="o">......+</span><span class="p">:</span><span class="o">.</span> <span class="o">..</span> <span class="p">:</span><span class="o">++.</span> <span class="o">..</span> <span class="p">:</span> <span class="o">.+</span><span class="p">:::</span><span class="o">+</span><span class="p">::</span> <span class="p">:</span> <span class="o">..</span> <span class="o">.</span> <span class="o">.+</span> <span class="p">::</span> <span class="o">+.</span><span class="p">:</span> <span class="o">.</span><span class="p">::</span><span class="o">+.</span> <span class="o">...+.</span> <span class="o">.</span><span class="p">:</span> <span class="o">.</span> <span class="o">.++</span><span class="p">:</span><span class="o">..</span> <span class="o">...</span> </pre></div> </div> <div class="section" id="hopefully-you-won-t-need-to-be-this-deep"> <h5>Hopefully you won’t need to be this deep<a class="headerlink" href="#hopefully-you-won-t-need-to-be-this-deep" title="Permalink to this headline">¶</a></h5> <p>If you need to do fancier things than what has been shown in this document, you can mail the list or check the <a class="reference external" href="http://spec.commonmark.org/0.28/">Common Mark spec</a>. Sphinx specific integration documentation can be found in the <a class="reference external" href="http://recommonmark.readthedocs.io/en/latest/index.html">recommonmark docs</a>.</p> </div> </div> </div> </div> </div> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="Phabricator.html" title="Code Reviews with Phabricator" >next</a> |</li> <li class="right" > <a href="SphinxQuickstartTemplate.html" title="Sphinx Quickstart Template" >previous</a> |</li> <li><a href="http://llvm.org/">LLVM Home</a> | </li> <li><a href="index.html">Documentation</a>»</li> </ul> </div> <div class="footer" role="contentinfo"> © Copyright 2003-2020, LLVM Project. Last updated on 2020-09-07. Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4. </div> </body> </html>