---

layout: home

title: "Quick Start with Docs as Code"

excerpt: "Use Git and GitHub, static site generators, and CICD systems to write and automate documentation builds so you can focus on writing and organizing excellent content."

search: false

show_excerpts: true

entries_layout: grid

---

<div>

<!-- <a href="https://www.docslikecode.com/learn/"><img src="images/learn/octocat-400x333.png" alt="Learn more" align="left" hspace="20" vspace="20" width="159"></a>

-->

<!-- <h2>Quick Start with GitHub Pages</h2> -->

<!-- <p>The fastest way to get started with docs-as-code with a web browser, internet connection, and GitHub account: </p> -->

<ol>

<li>Create a GitHub account at <a href="https://github.com">github.com</a>. Refer to <a href="https://justwriteclick.com/2019/01/14/github-pro-account-or-github-free-account-for-technical-writing/">GitHub Pro Account or GitHub Free Account for Technical Writing</a> if you're wondering which pricing plan makes sense for you. Free is likely fine!</li>

<li>In your browser, create a repository with the same name as your GitHub username, followed by "github.io".

For example, my repository name is "annegentle.github.io".</li>

<li>On the repository's main page, on the Code tab, click <em>Add file</em> > <em>Create new file</em>.

<p><img src="images/quickstart/add-file-create-new-file.png" alt="GitHub Add file and Create file" hspace="20" vspace="20" width="600"/></p>

</li>

<li>In the <em>Name your file...</em> field, enter "index.md" and under <em>Edit new file</em>, add a line or two of text that you want to publish as your new web landing page.

<p><img src="images/quickstart/edit-new-file.png" alt="GitHub Edit new file" hspace="20" vspace="20" width="400"/></p></li>

<li>Add a message if you like, and click <em>Commit new file</em>.

<p><img src="images/quickstart/commit-new-file.png" alt="GitHub Commit new file" hspace="20" vspace="20" width="500"/></p></li>

<li>Wait just a few seconds, then go to your new page, https://username.github.io. For an example, go to <a href="https://annegentle.github.io">annegentle.github.io</a>.

<li>If you don't see a page, check the settings for GitHub Pages by going to the <em>Settings</em> tab for the repository, and then click <em>Pages</em> in the left-hand side. The Settings should look similar to these:

<p><img src="images/quickstart/github-pages-settings.png" alt="GitHub repository Settings then Pages sidebar" hspace="20" vspace="20" width="800"/></li>

<li>Go to <a href="https://pages.github.com">pages.github.com</a> for even more scenarios. <p>That exercise gives you a taste of using GitHub as a content management system and publishing to a single web page automatically by pushing to a branch. Learn more by exploring the rest of this site.</p></li>

</ol>

</div>

<div>

<a href="https://www.docslikecode.com/learn/"><img src="images/learn/octocat-400x333.png" alt="Learn more" align="left" hspace="20" vspace="20" width="159"></a>

<h2>Learn the tools</h2>

<p><a href="https://www.docslikecode.com/learn/" class="btn btn--inverse"><i class='fa fa-graduation-cap'></i> Learn </a></p>

<p>Learning GitHub or any system backed by `git` takes some time and practice. Try some lessons with multiple static site generators and deployment systems as well as how to test docs as code.</p>

</div>

<div style="clear:both">

<a href="https://www.lulu.com/spotlight/justwriteclick"><img src="images/docs-like-code-book.jpg" alt="Docs Like Code Book" align="left" hspace="20" vspace="20" height="100" width="159"></a>

<h1>Buy the book</h1>

<p><a href="https://www.lulu.com/spotlight/justwriteclick" class="btn btn--inverse"><i class='fa fa-book'></i> Buy </a></p>

<p>We've transformed the way teams work together on docs, and we want to talk about the best practices for writing docs using development tools and techniques. Now in its second edition.</p>

</div>

<div style="clear:both">

<h2>Read the articles</h2>

<p>Read more <a href="{{base_url}}/articles/">articles</a> on this site about

using GitHub for documentation. Let's find out the best practices and create a balance point between artisanal craft and automation efficiency.

</p>

</div>