Skip to content

Commit db26b8a

Browse files
committed
Update landing with a quickstart for GitHub Pages
1 parent 0813124 commit db26b8a

5 files changed

Lines changed: 21 additions & 0 deletions

File tree

69.6 KB
Loading
94.9 KB
Loading
52.4 KB
Loading
271 KB
Loading

index.html

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,27 @@
77
entries_layout: grid
88
---
99

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 [github.com](https://github.com). Refer to [GitHub Pro Account or GitHub Free Account for Technical Writing](https://justwriteclick.com/2019/01/14/github-pro-account-or-github-free-account-for-technical-writing/) 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+
<img src="images/quickstart/add-file-create-new-file.png" alt="GitHub Add file and Create file" align="left" hspace="20" vspace="20" width="159"/></li>
22+
<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.
23+
<img src="images/quickstart/edit-new-file.png" alt="GitHub Edit new file" align="left" hspace="20" vspace="20" width="159"/></li>
24+
<li>Add a message if you like, and click <em>Commit new file</em>.
25+
<img src="images/quickstart/commit-new-file.png" alt="GitHub Commit new file" align="left" hspace="20" vspace="20" width="159"/></li>
26+
<li>Wait just a few seconds, then go to your new page, https://username.github.io. <p>If you don't see a page, you want to 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:
27+
<img src="images/quickstart/github-pages-settings.png" alt="GitHub repository Settings then Pages sidebar" align="left" hspace="20" vspace="20" width="159"/></p></li>
28+
</ol>
29+
</div>
30+
1031
<div>
1132
<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>
1233

0 commit comments

Comments
 (0)