Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added images/quickstart/add-file-create-new-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/quickstart/commit-new-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/quickstart/edit-new-file.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/quickstart/github-pages-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 25 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,36 @@
---
layout: home
title: "Docs as Code"
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>

Expand Down