{"id":19499601,"url":"https://github.com/stackbit/create-sourcebit","last_synced_at":"2025-10-29T11:35:16.233Z","repository":{"id":49675819,"uuid":"232583637","full_name":"stackbit/create-sourcebit","owner":"stackbit","description":"An interactive setup process for Sourcebit","archived":false,"fork":false,"pushed_at":"2021-06-10T23:42:46.000Z","size":323,"stargazers_count":9,"open_issues_count":2,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2023-03-05T18:15:55.467Z","etag":null,"topics":["jamstack","sourcebit"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/create-sourcebit","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stackbit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-08T14:35:47.000Z","updated_at":"2020-07-06T15:28:13.000Z","dependencies_parsed_at":"2022-07-31T16:48:56.552Z","dependency_job_id":null,"html_url":"https://github.com/stackbit/create-sourcebit","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-sourcebit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-sourcebit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-sourcebit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stackbit%2Fcreate-sourcebit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stackbit","download_url":"https://codeload.github.com/stackbit/create-sourcebit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224019614,"owners_count":17242176,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jamstack","sourcebit"],"created_at":"2024-11-10T22:05:01.728Z","updated_at":"2025-10-29T11:35:16.151Z","avatar_url":"https://github.com/stackbit.png","language":"JavaScript","readme":"# create-sourcebit\n\n[![npm version](https://badge.fury.io/js/create-sourcebit.svg)](https://badge.fury.io/js/create-sourcebit)\n\n\u003e An interactive setup process for [Sourcebit](https://github.com/stackbithq/sourcebit)\n\n## Introduction\n\n[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.\n\nEvery Sourcebit plugin must define the questions that should be asked and process the answers. This takes place via the `getSetup` and `getOptionsFromSetup` methods.\n\n## Plugin registry\n\nThe 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:\n\n-   `module` (String): The name of the plugin's npm module\n    -   _Example_: `sourcebit-source-contentful`\n-   `description` (String): A human-friendly description of the plugin\n    -   _Example_: `A Contentful source plugin for Sourcebit`\n-   `author` (String): The name/handle of the plugin's author\n    -   _Example_: `John Doe \u003cjohn.doe@example.com\u003e`\n-   `type` (enum: `source|target`): The type of plugin\n    -   _Example_: `source`\n\n_plugins.json_\n\n```json\n[\n    {\n        \"module\": \"/Users/eduardoboucas/Sites/sourcebit-source-contentful\",\n        \"description\": \"A Contentful source plugin for Sourcebit\",\n        \"author\": \"Stackbit\",\n        \"type\": \"source\"\n    },\n    {\n        \"module\": \"/Users/eduardoboucas/Sites/sourcebit-target-jekyll\",\n        \"description\": \"A Sourcebit plugin for Jekyll\",\n        \"author\": \"Stackbit\",\n        \"type\": \"target\"\n    }\n]\n```\n\n### Local plugin registry\n\nYou 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.\n\nTo 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.\n\n```shell\nnpx create-sourcebit --plugins=./my-plugins.json\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackbit%2Fcreate-sourcebit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstackbit%2Fcreate-sourcebit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstackbit%2Fcreate-sourcebit/lists"}