mirror of
https://github.com/shoelace-style/shoelace.git
synced 2026-01-12 02:59:13 +00:00
Adding Gitpod support (#661)
* Adding Gitpod setup * remove specifying vscode extensions in gitpod * Allow ports 4000-4999 * Make local dev env instructions the first option
This commit is contained in:
28
.gitpod.yml
Normal file
28
.gitpod.yml
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
tasks:
|
||||||
|
- init: npm install && npm run build
|
||||||
|
command: npm run start
|
||||||
|
|
||||||
|
ports:
|
||||||
|
- port: 3001
|
||||||
|
onOpen: ignore
|
||||||
|
- port: 4000-4999
|
||||||
|
onOpen: open-preview
|
||||||
|
|
||||||
|
github:
|
||||||
|
prebuilds:
|
||||||
|
# enable for the master/default branch (defaults to true)
|
||||||
|
master: true
|
||||||
|
# enable for all branches in this repo (defaults to false)
|
||||||
|
branches: true
|
||||||
|
# enable for pull requests coming from this repo (defaults to true)
|
||||||
|
pullRequests: true
|
||||||
|
# enable for pull requests coming from forks (defaults to false)
|
||||||
|
pullRequestsFromForks: true
|
||||||
|
# add a check to pull requests (defaults to true)
|
||||||
|
addCheck: true
|
||||||
|
# add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
|
||||||
|
addComment: false
|
||||||
|
# add a "Review in Gitpod" button to the pull request's description (defaults to false)
|
||||||
|
addBadge: true
|
||||||
|
# add a label once the prebuild is ready to pull requests (defaults to false)
|
||||||
|
addLabel: true
|
||||||
@@ -90,6 +90,9 @@ npm run start
|
|||||||
|
|
||||||
After the initial build, a browser will open automatically to a local version of the docs. The documentation is powered by Docsify, which uses raw markdown files to generate pages on the fly.
|
After the initial build, a browser will open automatically to a local version of the docs. The documentation is powered by Docsify, which uses raw markdown files to generate pages on the fly.
|
||||||
|
|
||||||
|
Alternatively, you can use Gitpod for a dev environment in the cloud (no local setup is needed, everything is done through your browser)
|
||||||
|
[](https://gitpod.io/#https://github.com/shoelace-style/shoelace)
|
||||||
|
|
||||||
### Creating New Components
|
### Creating New Components
|
||||||
|
|
||||||
To scaffold a new component, run the following command, replacing `sl-tag-name` with the desired tag name.
|
To scaffold a new component, run the following command, replacing `sl-tag-name` with the desired tag name.
|
||||||
|
|||||||
Reference in New Issue
Block a user