Add /dev/index.html for local dev. Update README
This commit is contained in:
committed by
Justin Fagnani
parent
fe5a424bee
commit
9d33e2436d
29
README.md
29
README.md
@@ -47,6 +47,9 @@ To run the dev server and open the project in a new browser tab:
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
|
||||
There is a development HTML file located at `/dev/index.html` that you can view at http://localhost:8000/dev/index.html.
|
||||
|
||||
## Editing
|
||||
|
||||
If you use VS Code, we highly reccomend the [lit-plugin extension](https://marketplace.visualstudio.com/items?itemName=runem.lit-plugin), which enables some extremely useful features for lit-html templates:
|
||||
@@ -78,6 +81,32 @@ npm run lint
|
||||
|
||||
Prettier has not been configured to run when commiting files, but this can be added with Husky and and `pretty-quick`. See the [prettier.io](https://prettier.io/) site for instructions.
|
||||
|
||||
## Static Site
|
||||
|
||||
This project includes a simple website generated with the [eleventy](11ty.dev) static site generator and the templates and pages in `/docs-src`. The site is generated to `/docs` and intended to be checked in so that GitHub pages can serve the site [from `/docs` on the master branch](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).
|
||||
|
||||
To enable the site go to the GitHub settings and change the GitHub Pages "Source" setting to "master branch /docs folder".</p>
|
||||
|
||||
To build the site, run:
|
||||
|
||||
```bash
|
||||
npm run docs
|
||||
```
|
||||
|
||||
To serve the site locally, run:
|
||||
|
||||
```bash
|
||||
npm run docs:serve
|
||||
```
|
||||
|
||||
To watch the site files, and re-build automatically, run:
|
||||
|
||||
```bash
|
||||
npm run docs:watch
|
||||
```
|
||||
|
||||
The site will usually be served at http://localhost:8000.
|
||||
|
||||
## More information
|
||||
|
||||
See [Get started](https://lit-element.polymer-project.org/guide/start) on the LitElement site for more information.
|
||||
|
||||
Reference in New Issue
Block a user