|
1 | 1 | --- |
2 | 2 | layout: home |
3 | | -title: "Docs as Code" |
| 3 | +title: "Quick Start with Docs as Code" |
4 | 4 | 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." |
5 | 5 | search: false |
6 | 6 | show_excerpts: true |
7 | 7 | entries_layout: grid |
8 | 8 | --- |
9 | 9 |
|
| 10 | +<div> |
| 11 | + <!-- <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> |
| 12 | + --> |
| 13 | + <!-- <h2>Quick Start with GitHub Pages</h2> --> |
| 14 | + |
| 15 | + <!-- <p>The fastest way to get started with docs-as-code with a web browser, internet connection, and GitHub account: </p> --> |
| 16 | + <ol> |
| 17 | + <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> |
| 18 | + <li>In your browser, create a repository with the same name as your GitHub username, followed by "github.io". |
| 19 | + For example, my repository name is "annegentle.github.io".</li> |
| 20 | + <li>On the repository's main page, on the Code tab, click <em>Add file</em> > <em>Create new file</em>. |
| 21 | + <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> |
| 22 | + </li> |
| 23 | + <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. |
| 24 | + <p><img src="images/quickstart/edit-new-file.png" alt="GitHub Edit new file" hspace="20" vspace="20" width="400"/></p></li> |
| 25 | + <li>Add a message if you like, and click <em>Commit new file</em>. |
| 26 | + <p><img src="images/quickstart/commit-new-file.png" alt="GitHub Commit new file" hspace="20" vspace="20" width="500"/></p></li> |
| 27 | + <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>. |
| 28 | + <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: |
| 29 | + <p><img src="images/quickstart/github-pages-settings.png" alt="GitHub repository Settings then Pages sidebar" hspace="20" vspace="20" width="800"/></li> |
| 30 | + <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> |
| 31 | + </ol> |
| 32 | + </div> |
| 33 | + |
10 | 34 | <div> |
11 | 35 | <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> |
12 | 36 |
|
|
0 commit comments