This repository has been archived by the owner on Jul 19, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 363
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Chris Berthe
authored
May 3, 2018
1 parent
6bc0867
commit 4fa3ef5
Showing
1 changed file
with
4 additions
and
41 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,7 @@ | ||
# Create Slate Theme | ||
[![npm version](https://badge.fury.io/js/create-slate-theme.svg)](https://badge.fury.io/js/create-slate-theme) | ||
|
||
Start a new Slate project with a single command. Defaults to creating a fresh copy of [`Shopify/starter-theme`](https://github.com/Shopify/starter-theme): | ||
# create-slate-theme | ||
|
||
## Getting Started | ||
The `create-slate-theme` package enables users to create a new Slate project with a single command. | ||
|
||
To get started with a new project, run the following command in your terminal: | ||
|
||
``` | ||
yarn create slate-theme my-new-theme | ||
``` | ||
|
||
or if you prefer NPM | ||
|
||
``` | ||
npm install -g create-slate-theme | ||
create-slate-theme my-new-theme | ||
``` | ||
|
||
## Custom Starting Points | ||
|
||
Instead of using [shopify/starter-theme](https://github.com/Shopify/starter-theme), you can optionally specify your own Github repo or local folder to copy as a starting point: | ||
|
||
``` | ||
yarn create slate-theme my-new-theme shopify/skeleton-theme | ||
``` | ||
|
||
or | ||
|
||
``` | ||
yarn create slate-theme my-new-theme my-old-theme/ | ||
``` | ||
|
||
You can share your starting point with the community by publishing your own starter theme to Github. For example, I could publish my own starter theme in the t-kelly/custom-starter-theme repo and then start a new project with it by calling: | ||
|
||
``` | ||
yarn create slate-theme my-new-theme t-kelly/custom-starter-theme | ||
``` | ||
|
||
## Options | ||
|
||
#### --skipInstall | ||
|
||
Skips installing theme dependencies which greatly speeds up overall setup time. | ||
For more information, visit [the Wiki](https://github.com/Shopify/slate/wiki/Create-Slate-Theme). |