Skip to content

Commit dad7422

Browse files
committed
docs: split and add to docs
1 parent c9ee216 commit dad7422

File tree

6 files changed

+83
-28
lines changed

6 files changed

+83
-28
lines changed

README.md

Lines changed: 6 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212

1313
<div align="center">
1414
<a href="https://michaelcurrin.github.io/">
15-
<img src="/sample.png"
16-
alt="Sample screenshot"
17-
title="Go to site"
15+
<img src="/sample.png"
16+
alt="Sample screenshot"
17+
title="Go to site"
1818
width="500" />
1919
</a>
2020
</div>
@@ -28,36 +28,14 @@
2828

2929
</div>
3030

31-
Forked from the [github/personal-website](https://github.com/github/personal-website) repo.
31+
Forked from the [github/personal-website](https://github.com/github/personal-website) repo.
3232

3333
You can [fork](https://github.com/github/personal-website/fork) that original project and make your own.
3434

3535

36-
## Development
37-
> Notes for editing this repo
36+
## Documentation
3837

39-
### Content and templates
40-
41-
- `interests.html`: A heading and dynamic list of "My Interests," which is populated with the [topics](#topics) you list in your `_config.yml`.
42-
- `masthead.html`: A collection of your avatar, name, bio, and other metadata that's displayed prominently on all your webpages to help identify what the website is about.
43-
- `post-card.html`: A compact, summarized presentation of a blog post, re-used to display a listing of your latest blog posts.
44-
- `projects.html`: A heading and dynamic list of "My Projects," which is populated with a listing of your newest GitHub repositories.
45-
- `repo-card.html`: A compact, summarized presentation of a repository, re-used to display a listing of your GitHub repositories.
46-
- `thoughts.html`: A heading and dynamic list of "My Thoughts," which is populated with a listing of your latest blog posts.
47-
- `topic-card.html`: A compact, summarized presentation of a topic (defined in your `_config.yml`), re-used to display a listing of your interests.
48-
49-
### Styles
50-
51-
The website is pre-configured to use [GitHub's very flexible CSS framework called "Primer"](https://styleguide.github.com/primer/). It's currently referenced within your `styles.scss` file, using the CSS `@import` rule.
52-
53-
See `/assets/styles.scss` Sass stylesheet. By editing this file, you can customize the website's color scheme, typography, and more.
54-
55-
### Icons
56-
57-
The Octicons gem is _not_ listed directly under [Dependency versions](https://pages.github.com/versions/), but it still works on GH Pages.
58-
59-
- [octicons](https://rubygems.org/gems/octicons) on Ruby gems.
60-
- [octicons](https://github.com/primer/octicons) on GitHub. Linked to from the now-deprecated [jekyll-octicons](https://github.com/primer/jekyll-octicons) repo.
38+
See [docs](/docs/).
6139

6240

6341
## License

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Documentation

docs/development.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Development
2+
> Notes for editing this repo
3+
4+
5+
## Content and templates
6+
7+
- `interests.html`: A heading and dynamic list of "My Interests," which is populated with the [topics](#topics) you list in your `_config.yml`.
8+
- `masthead.html`: A collection of your avatar, name, bio, and other metadata that's displayed prominently on all your webpages to help identify what the website is about.
9+
- `post-card.html`: A compact, summarized presentation of a blog post, re-used to display a listing of your latest blog posts.
10+
- `projects.html`: A heading and dynamic list of "My Projects," which is populated with a listing of your newest GitHub repositories.
11+
- `repo-card.html`: A compact, summarized presentation of a repository, re-used to display a listing of your GitHub repositories.
12+
- `thoughts.html`: A heading and dynamic list of "My Thoughts," which is populated with a listing of your latest blog posts.
13+
- `topic-card.html`: A compact, summarized presentation of a topic (defined in your `_config.yml`), re-used to display a listing of your interests.
14+
15+
## Styles
16+
17+
The website is pre-configured to use [GitHub's very flexible CSS framework called "Primer"](https://styleguide.github.com/primer/). It's currently referenced within your `styles.scss` file, using the CSS `@import` rule.
18+
19+
See `/assets/styles.scss` Sass stylesheet. By editing this file, you can customize the website's color scheme, typography, and more.
20+
21+
## Icons
22+
23+
The Octicons gem is _not_ listed directly under [Dependency versions](https://pages.github.com/versions/), but it still works on GH Pages.
24+
25+
- [octicons](https://rubygems.org/gems/octicons) on Ruby gems.
26+
- [octicons](https://github.com/primer/octicons) on GitHub. Linked to from the now-deprecated [jekyll-octicons](https://github.com/primer/jekyll-octicons) repo.

docs/installation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Installation
2+
3+
4+
### Install project packages
5+
6+
```sh
7+
$ make install
8+
```

docs/sitemap.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Sitemap
2+
3+
I have a lot of GitHub Pages sites.
4+
5+
The main one is set up in the Google SEO Console as:
6+
7+
- `https://michaelcurrin.github.io/sitemap.xml`
8+
9+
I then link to other sites in that sitemap, to ensure Google crawls them all.
10+
11+
12+
## Manual set up
13+
14+
Sites listed in:
15+
16+
- [\_data/gh_pages_sites.yml](/_data/gh_pages_sites.yml)
17+
18+
I can preview as clickable links with:
19+
20+
- [\_sites-test.md](/_sites-test.md)
21+
22+
Currently ignore because of leading forward slash.
23+
24+
25+
## Automated set up
26+
27+
Maybe one day I'll use the GitHub API to get all my repos and check if they have GitHub Pages enabled, then build the sitemap from that.
28+
29+
Some sites with also have URL in the API response but will be outside of GitHub Pages and need to have their own sitemap and registration in Google SEO Console.

docs/usage.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Usage
2+
3+
### Start dev server
4+
5+
```sh
6+
$ make serve
7+
```
8+
9+
### Build
10+
11+
```sh
12+
$ make build
13+
```

0 commit comments

Comments
 (0)