index.xhtml 664 B

1234567891011121314
  1. <h1 id="welcome-to-mkdocs">Welcome to MkDocs</h1>
  2. <p>For full documentation visit <a href="http://mkdocs.org">mkdocs.org</a>.</p>
  3. <h2 id="commands">Commands</h2>
  4. <ul>
  5. <li><code>mkdocs new [dir-name]</code> - Create a new project.</li>
  6. <li><code>mkdocs serve</code> - Start the live-reloading docs server.</li>
  7. <li><code>mkdocs build</code> - Build the documentation site.</li>
  8. <li><code>mkdocs help</code> - Print this help message.</li>
  9. </ul>
  10. <h2 id="project-layout">Project layout</h2>
  11. <pre><code>mkdocs.yml # The configuration file.
  12. docs/
  13. index.md # The documentation homepage.
  14. ... # Other markdown pages, images and other files.</code></pre>