Skip to content
This repository was archived by the owner on Jun 4, 2023. It is now read-only.

Commit f49f600

Browse files
committed
Detaching stackbit-pull
- Updated Readme files
1 parent 0cd93ea commit f49f600

File tree

3 files changed

+62
-15
lines changed

3 files changed

+62
-15
lines changed

packages/contentful/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
1-
# `contentful`
1+
# contentful-pull
22

3-
> TODO: description
3+
Stackbit Contentful pull, is a build tool that fetches stackbit site data from contentful and prepares it for
4+
SSG build.
45

5-
## Usage
6+
Usage:
7+
```
8+
Usage: contentful-pull [options]
69
10+
Options:
11+
--ssg <ssg> [required] Which SSG are you using [jekyll, hugo, gatbsby]
12+
--contentful-space-id <contentfulSpaceId> [required] Contentful Space ID, can be also specified through CONTENTFUL_SPACE_ID environment variable
13+
--contentful-access-token <contentfulAccessToken> [required] Contentful access token, can be also specified through CONTENTFUL_ACCESS_TOKEN environment variable
14+
--contentful-environment <contentfulEnvironment> [optional] Contentful environment, can be also specified through CONTENTFUL_ENVIRONMENT environment variable
15+
-h, --help output usage information
716
```
8-
const contentful = require('contentful');
917

10-
// TODO: DEMONSTRATE API
18+
- `ssg`: Defines which file format should be used when creating pages and data for your site. Required
19+
- `contentfulSpaceId`: Contentful space id. Required. Can be also specified via CONTENTFUL_SPACE_ID environment variable.
20+
- `contentfulAccessToken`: Contentful delivery token, can be obtained from the API Keys page of your contentful space https://app.contentful.com/spaces/{space_id}/api/keys. Can be also specified via CONTENTFUL_ACCESS_TOKEN environment variable.
21+
- `contentfulEnvironment`: Contentful environment, optional. Uses `master` by default. Can be also specified via CONTENTFUL_ENVIRONMENT environment variable.
22+
23+
## Examples
24+
25+
Using `npx`:
26+
```
27+
npx @stackbit/contentful-pull --ssg gatsby --contentful-space-id $CONTENTFUL_SPACE_ID --contentful-access-token $CONTENTFUL_ACCESS_TOKEN
1128
```

packages/datocms/README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
1-
# `datocms`
1+
# datocms-pull
22

3-
> TODO: description
3+
Stackbit DatoCMS pull, is a build tool that fetches stackbit site data from DatoCMS and prepares it for
4+
SSG build.
45

5-
## Usage
6+
Usage:
7+
```
8+
Usage: datocms-pull [options]
69
10+
Options:
11+
--ssg <ssg> [required] Which SSG are you using [jekyll, hugo, gatbsby]
12+
--datocms-access-token <datocmsAccessToken> [required] DatoCMS access token, can be also specified through DATOCMS_ACCESS_TOKEN environment variable
13+
-h, --help output usage information
714
```
8-
const datocms = require('datocms-client');
915

10-
// TODO: DEMONSTRATE API
16+
- `ssg`: Defines which file format should be used when creating pages and data for your site. Required
17+
- `datocmsAccessToken`: DatoCMS access token, can be obtained from the API tokens admin page of your DatoCMS project https://{project_id}.admin.datocms.com/admin/access_tokens. Can be also specified via DATOCMS_ACCESS_TOKEN environment variable.
18+
19+
## Examples
20+
21+
Using `npx`:
22+
```
23+
npx @stackbit/datocms-pull --ssg gatsby --datocms-access-token $DATOCMS_ACCESS_TOKEN
1124
```

packages/sanity/README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
1-
# `sanity`
1+
# sanity-pull
22

3-
> TODO: description
3+
Stackbit Sanity pull, is a build tool that fetches stackbit site data from sanity and prepares it for
4+
SSG build.
45

5-
## Usage
6+
Usage:
7+
```
8+
Usage: sanity-pull [options]
69
10+
Options:
11+
--ssg <ssg> [required] Which SSG are you using [jekyll, hugo, gatbsby]
12+
--sanity-project-id <sanityProjectId> [required] Sanity Project ID, can be also specified through SANITY_PROJECT_ID environment variable
13+
--sanity-access-token <sanityAccessToken> [required] Sanity access token, can be also specified through SANITY_ACCESS_TOKEN environment variable
14+
--sanity-dataset <dataset> [optional] Sanity dataset, can be also specified through SANITY_DATASET environment variable
15+
-h, --help output usage information
716
```
8-
const sanity = require('sanity');
917

10-
// TODO: DEMONSTRATE API
18+
- `ssg`: Defines which file format should be used when creating pages and data for your site. Required
19+
- `sanityProjectId`: Sanity Project ID. Required. Can be also specified via SANITY_PROJECT_ID environment variable.
20+
- `sanityAccessToken`: Sanity access token, can be obtained from the API Settings page of your sanity manage panel https://manage.sanity.io/projects/{project_id}/settings/api. Can be also specified via SANITY_ACCESS_TOKEN environment variable.
21+
- `dataset`: Sanity dataset, optional. Uses `production` by default. Can be also specified via SANITY_DATASET environment variable.
22+
23+
## Examples
24+
25+
Using `npx`:
26+
```
27+
npx @stackbit/sanity-pull --ssg gatsby --sanity-project-id $SANITY_PROJECT_ID --sanity-access-token $SANITY_ACCESS_TOKEN
1128
```

0 commit comments

Comments
 (0)