https://github.com/stackbit/create-sourcebit

An interactive setup process for Sourcebit
https://github.com/stackbit/create-sourcebit

jamstack sourcebit

Last synced: 3 days ago
JSON representation

An interactive setup process for Sourcebit

• Host: GitHub
• URL: https://github.com/stackbit/create-sourcebit
• Owner: stackbit
• License: mit
• Created: 2020-01-08T14:35:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-06-10T23:42:46.000Z (over 3 years ago)
• Last Synced: 2023-03-05T18:15:55.467Z (over 1 year ago)
• Topics: jamstack, sourcebit
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/create-sourcebit
• Size: 315 KB
• Stars: 9
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# create-sourcebit

[![npm version](https://badge.fury.io/js/create-sourcebit.svg)](https://badge.fury.io/js/create-sourcebit)

> An interactive setup process for [Sourcebit](https://github.com/stackbithq/sourcebit)

## Introduction

[Sourcebit](https://github.com/stackbithq/sourcebit) uses a [configuration file](https://github.com/stackbithq/sourcebit#configuration) of `sourcebit.js` to define and configure all of its plugins. While this file can be created manually, this command-line interface provides an interactive setup that gathers enough information about the user's environment and content architecture to create a working configuration.

Every Sourcebit plugin must define the questions that should be asked and process the answers. This takes place via the `getSetup` and `getOptionsFromSetup` methods.

## Plugin registry

The list of plugins offered by the interactive setup process is pulled from the `plugins.json` file in the root of the repository. It's an array of objects with the following properties:

-   `module` (String): The name of the plugin's npm module

    -   _Example_: `sourcebit-source-contentful`

-   `description` (String): A human-friendly description of the plugin

    -   _Example_: `A Contentful source plugin for Sourcebit`

-   `author` (String): The name/handle of the plugin's author

    -   _Example_: `John Doe `

-   `type` (enum: `source|target`): The type of plugin

    -   _Example_: `source`

_plugins.json_

```json

[

    {

        "module": "/Users/eduardoboucas/Sites/sourcebit-source-contentful",

        "description": "A Contentful source plugin for Sourcebit",

        "author": "Stackbit",

        "type": "source"

    },

    {

        "module": "/Users/eduardoboucas/Sites/sourcebit-target-jekyll",

        "description": "A Sourcebit plugin for Jekyll",

        "author": "Stackbit",

        "type": "target"

    }

]

```

### Local plugin registry

You can create your own `plugins.json` file and tell the setup process to use it. This is useful when you're developing a plugin locally and you want it to appear on the list of available plugins without having to publish it to the official registry.

To use a local plugin registry, create a file with the structure above and start the setup process with the `--plugins` flag pointing to its path.

```shell

npx create-sourcebit --plugins=./my-plugins.json

```