Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Commit 8d82698

Browse files
authored
Initial commit
0 parents  commit 8d82698

14 files changed

+18809
-0
lines changed

.github/dependabot.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "npm" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "daily"
12+
allow:
13+
- dependency-name: "@primer/gatsby-theme-doctocat"

.gitignore

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# TypeScript v1 declaration files
45+
typings/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Optional REPL history
57+
.node_repl_history
58+
59+
# Output of 'npm pack'
60+
*.tgz
61+
62+
# Yarn Integrity file
63+
.yarn-integrity
64+
65+
# dotenv environment variables file
66+
.env
67+
.env.test
68+
69+
# parcel-bundler cache (https://parceljs.org/)
70+
.cache
71+
72+
# next.js build output
73+
.next
74+
75+
# nuxt.js build output
76+
.nuxt
77+
78+
# vuepress build output
79+
.vuepress/dist
80+
81+
# Serverless directories
82+
.serverless/
83+
84+
# FuseBox cache
85+
.fusebox/
86+
87+
# DynamoDB Local files
88+
.dynamodb/
89+
90+
# Gatsby
91+
public/

.prettierrc

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"trailingComma": "all",
3+
"bracketSpacing": false,
4+
"semi": false,
5+
"singleQuote": true
6+
}

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Doctocat Template
2+
3+
4+
## Getting Started
5+
6+
1. Install dependencies
7+
8+
`yarn`
9+
10+
2. Build the site (this only needs to be done once)
11+
12+
`yarn run build`
13+
14+
3. Run the development server
15+
16+
`yarn run develop`

babel.config.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"plugins": [ "@babel/plugin-proposal-logical-assignment-operators" ],
3+
"presets": [
4+
[
5+
"babel-preset-gatsby",
6+
{
7+
"targets": {
8+
"browsers": [
9+
">0.25%",
10+
"not dead"
11+
]
12+
}
13+
}
14+
]
15+
]
16+
}

content/example/index.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Example
3+
---
4+
5+
Example

content/example/page-2.mdx

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Page 2
3+
---
4+
5+
Page 2

content/index.mdx

+179
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,179 @@
1+
---
2+
title: Doctocat Template
3+
---
4+
5+
import {HeroLayout} from '@primer/gatsby-theme-doctocat'
6+
export default HeroLayout
7+
8+
Text can be **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com) should be blue with no underlines (unless hovered over).
9+
10+
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.
11+
12+
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.
13+
14+
> There should be no margin above this first sentence.
15+
>
16+
> Blockquotes should be a lighter gray with a gray border along the left side.
17+
>
18+
> There should be no margin below this final sentence.
19+
20+
# Header 1
21+
22+
This is a normal paragraph following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
23+
24+
## Header 2
25+
26+
> This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
27+
28+
### Header 3
29+
30+
```
31+
This is a code block following a header.
32+
```
33+
34+
#### Header 4
35+
36+
- This is an unordered list following a header.
37+
- This is an unordered list following a header.
38+
- This is an unordered list following a header.
39+
40+
##### Header 5
41+
42+
1. This is an ordered list following a header.
43+
2. This is an ordered list following a header.
44+
3. This is an ordered list following a header.
45+
46+
###### Header 6
47+
48+
| What | Follows |
49+
| ------- | -------- |
50+
| A table | A header |
51+
| A table | A header |
52+
| A table | A header |
53+
54+
---
55+
56+
There's a horizontal rule above and below this.
57+
58+
---
59+
60+
Here is an unordered list:
61+
62+
- Salt-n-Pepa
63+
- Bel Biv DeVoe
64+
- Kid 'N Play
65+
66+
And an ordered list:
67+
68+
1. Michael Jackson
69+
2. Michael Bolton
70+
3. Michael Bublé
71+
72+
And an unordered task list:
73+
74+
- [x] Create a sample markdown document
75+
- [x] Add task lists to it
76+
- [ ] Take a vacation
77+
78+
And a "mixed" task list:
79+
80+
- [ ] Steal underpants
81+
- ?
82+
- [ ] Profit!
83+
84+
And a nested list:
85+
86+
- Jackson 5
87+
- Michael
88+
- Tito
89+
- Jackie
90+
- Marlon
91+
- Jermaine
92+
- TMNT
93+
- Leonardo
94+
- Michelangelo
95+
- Donatello
96+
- Raphael
97+
98+
Definition lists can be used with HTML syntax. Definition terms are bold and italic.
99+
100+
<dl>
101+
<dt>Name</dt>
102+
<dd>Godzilla</dd>
103+
<dt>Born</dt>
104+
<dd>1952</dd>
105+
<dt>Birthplace</dt>
106+
<dd>Japan</dd>
107+
<dt>Color</dt>
108+
<dd>Green</dd>
109+
</dl>
110+
111+
---
112+
113+
Tables should have bold headings and alternating shaded rows.
114+
115+
| Artist | Album | Year |
116+
| --------------- | -------------- | ---- |
117+
| Michael Jackson | Thriller | 1982 |
118+
| Prince | Purple Rain | 1984 |
119+
| Beastie Boys | License to Ill | 1986 |
120+
121+
If a table is too wide, it should condense down and/or scroll horizontally.
122+
123+
| Artist | Album | Year | Label | Awards | Songs |
124+
| --------------- | -------------- | ---- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
125+
| Michael Jackson | Thriller | 1982 | Epic Records | Grammy Award for Album of the Year, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Selling Album, Grammy Award for Best Engineered Album, Non-Classical | Wanna Be Startin' Somethin', Baby Be Mine, The Girl Is Mine, Thriller, Beat It, Billie Jean, Human Nature, P.Y.T. (Pretty Young Thing), The Lady in My Life |
126+
| Prince | Purple Rain | 1984 | Warner Brothers Records | Grammy Award for Best Score Soundtrack for Visual Media, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Soundtrack/Cast Recording, Grammy Award for Best Rock Performance by a Duo or Group with Vocal | Let's Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I'm a Star, Purple Rain |
127+
| Beastie Boys | License to Ill | 1986 | Mercury Records | noawardsbutthistablecelliswide | Rhymin & Stealin, The New Style, She's Crafty, Posse in Effect, Slow Ride, Girls, (You Gotta) Fight for Your Right, No Sleep Till Brooklyn, Paul Revere, Hold It Now, Hit It, Brass Monkey, Slow and Low, Time to Get Ill |
128+
129+
---
130+
131+
Code snippets like `var foo = "bar";` can be shown inline.
132+
133+
Also, `this should vertically align` ~~`with this`~~ ~~and this~~.
134+
135+
Code can also be shown in a block element.
136+
137+
```
138+
var foo = "bar";
139+
```
140+
141+
Code can also use syntax highlighting.
142+
143+
```javascript
144+
var foo = 'bar'
145+
```
146+
147+
```
148+
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
149+
```
150+
151+
```javascript
152+
var foo =
153+
'The same thing is true for code with syntax highlighting. A single line of code should horizontally scroll if it is really long.'
154+
```
155+
156+
```jsx live
157+
<div>Live example</div>
158+
```
159+
160+
Inline code inside table cells should still be distinguishable.
161+
162+
| Language | Code |
163+
| ---------- | ------------------ |
164+
| Javascript | `var foo = "bar";` |
165+
| Ruby | `foo = "bar"` |
166+
167+
---
168+
169+
Small images should be shown at their actual size.
170+
171+
![](http://placekitten.com/g/300/200/)
172+
173+
Large images should always scale down and fit in the content container.
174+
175+
![](http://placekitten.com/g/1200/800/)
176+
177+
```
178+
This is the final element on the page and there should be no margin below this.
179+
```

content/page-1.mdx

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: Page 1
3+
---
4+
5+
Page 1
6+
7+
8+
## Subheading
9+
10+
11+
## Subheading 2

gatsby-config.js

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
siteMetadata: {
3+
title: 'Doctocat Template',
4+
shortName: 'Template',
5+
description: 'My site description',
6+
},
7+
plugins: ['@primer/gatsby-theme-doctocat'],
8+
}

now.json

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": 2,
3+
"name": "doctocat-template",
4+
"builds": [
5+
{
6+
"src": "package.json",
7+
"use": "@now/static-build",
8+
"config": {"distDir": "public"}
9+
}
10+
]
11+
}

package.json

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"name": "doctocat-template",
3+
"repository": "primer/doctocat-template",
4+
"version": "1.1.0",
5+
"scripts": {
6+
"develop": "gatsby develop",
7+
"build": "gatsby build",
8+
"now-build": "yarn run build"
9+
},
10+
"dependencies": {
11+
"@primer/gatsby-theme-doctocat": "^4.0.0",
12+
"gatsby": "^2.32.13",
13+
"react": "^16.9.0",
14+
"react-dom": "^16.9.0"
15+
},
16+
"devDependencies": {
17+
"@babel/plugin-proposal-logical-assignment-operators": "^7.18.9",
18+
"babel-preset-gatsby": "^2.20.0"
19+
}
20+
}

0 commit comments

Comments
 (0)