Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 898caf5

Browse files
committedSep 24, 2020
Moving the APIdocs theme documentation to the theme repository.
The starter will now contain some very basic content with links to the documentation.
1 parent c21bdee commit 898caf5

19 files changed

+4476
-3482
lines changed
 

‎gatsby-config.js

+13-30
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,25 @@
1+
const projectPackage = require("./package.json");
2+
13
module.exports = {
2-
pathPrefix: '__RELATIVIZE_PREFIX__',
34
siteMetadata: {
4-
title: `APIdocs documentation`,
5+
title: `APIdocs starter project`,
56
description: `APIdocs is an opinionated Gatsby template for writing technical documentation. Clone, customize and start documenting.`,
67
lang: `en`,
7-
indexAlias: `/getting-started/`
8+
indexAlias: `/hello/`
89
},
910
plugins: [
1011
{
11-
resolve: `gatsby-source-filesystem`,
12-
options: {
13-
name: `content`,
14-
path: `${__dirname}/src/content`,
15-
},
16-
},
17-
{
18-
resolve: `@carrotsearch/gatsby-plugin-apidocs`,
12+
resolve: `@carrotsearch/gatsby-theme-apidocs`,
1913
options: {
2014
navigation: `${__dirname}/src/navigation.json`,
21-
logo: `${__dirname}/src/logo.html`,
15+
logo: `${__dirname}/src/logo.html`,
2216
footer: `${__dirname}/src/footer.html`,
23-
basePath: "src/content"
24-
}
25-
},
26-
{
27-
resolve: `gatsby-plugin-nprogress`,
28-
options: {
29-
color: `#ffaa00`,
30-
showSpinner: false
17+
basePath: "src/content",
18+
variables: {
19+
"APIDOCS_STARTER_VERSION": projectPackage.version,
20+
"BUILD_TYPE": "public"
21+
}
3122
}
32-
},
33-
`gatsby-plugin-sharp`,
34-
`gatsby-plugin-react-helmet`,
35-
`gatsby-plugin-dark-mode`,
36-
`@carrotsearch/gatsby-transformer-html`,
37-
'@carrotsearch/gatsby-plugin-content-search',
38-
`gatsby-plugin-offline`,
39-
`gatsby-plugin-catch-links`,
40-
`@carrotsearch/gatsby-plugin-relativize`
23+
}
4124
]
42-
};
25+
}

‎package.json

+6-21
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,18 @@
11
{
22
"name": "gatsby-starter-apidocs",
33
"private": true,
4-
"description": "Starter project for the Gatsby APIdocs system. Clone, customize and start documenting.",
5-
"version": "1.0.0",
4+
"description": "Starter project for the Gatsby APIdocs theme. Clone, customize and start documenting.",
5+
"version": "1.1.0",
66
"scripts": {
77
"build": "gatsby build --prefix-paths",
88
"clean": "gatsby clean",
99
"develop": "gatsby develop",
10-
"start": "npm run develop",
1110
"serve": "gatsby serve --prefix-paths"
1211
},
1312
"dependencies": {
14-
"gatsby": "2.17.17",
15-
"gatsby-plugin-catch-links": "2.1.27",
16-
"gatsby-plugin-dark-mode": "1.1.1",
17-
"gatsby-plugin-react-helmet": "3.1.23",
18-
"gatsby-source-filesystem": "2.1.53",
19-
"gatsby-plugin-offline": "2.2.10",
20-
"gatsby-plugin-nprogress": "2.1.20",
21-
"@carrotsearch/gatsby-plugin-apidocs": "1.0.21",
22-
"@carrotsearch/gatsby-transformer-html": "1.0.22",
23-
"@carrotsearch/gatsby-plugin-content-search": "1.0.0",
24-
"@carrotsearch/gatsby-plugin-relativize": "1.0.3",
25-
26-
"react": "16.13.0",
27-
"react-dom": "16.13.0",
28-
"react-helmet": "5.2.1"
29-
},
30-
"devDependencies": {
31-
"shelljs": "^0.8.3"
13+
"gatsby": "2.24.63",
14+
"@carrotsearch/gatsby-theme-apidocs": "0.1.1",
15+
"react": "16.13.1",
16+
"react-dom": "16.13.1"
3217
}
3318
}

‎readme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# APIDocs starter
22

3-
APIdocs is an opinionated Gatsby template for writing technical documentation. Clone, customize and start documenting.
3+
APIdocs is an opinionated Gatsby theme for writing technical documentation. Clone, customize and start documenting.
44

55
[Complete documentation](https://carrotsearch.github.io/apidocs/)
66

0 commit comments

Comments
 (0)
Please sign in to comment.