Skip to content
This repository has been archived by the owner on Apr 19, 2021. It is now read-only.

Commit

Permalink
add initial file
Browse files Browse the repository at this point in the history
add to menus

add intro

add external resources area

add first vscode extensions

add another examlpe

add try it in gitpod

remove unneeded `(`

talk about prebuilds

Update src/docs/html_in_gitpod.md

Co-Authored-By: Jan Keromnes <[email protected]>

Update src/docs/html_in_gitpod.md

Co-Authored-By: Jan Keromnes <[email protected]>

Update src/docs/html_in_gitpod.md

Co-Authored-By: Jan Keromnes <[email protected]>

Update src/docs/html_in_gitpod.md

Co-Authored-By: Jan Keromnes <[email protected]>

Update src/docs/html_in_gitpod.md

Co-Authored-By: Jan Keromnes <[email protected]>

Update src/docs/html_in_gitpod.md

Co-Authored-By: Jan Keromnes <[email protected]>
  • Loading branch information
Sean Hellum and jankeromnes committed Jan 22, 2020
1 parent ad66b76 commit 690d24f
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 0 deletions.
50 changes: 50 additions & 0 deletions src/docs/html-in-gitpod.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# HTML

Looking to try web development in Gitpod? Well you're in luck: Gitpod was made with web development in mind. And, depending on your needs, you may want to customize this experience further!

## Workspace Configuration

### VSCode Extensions

#### [HTML-Snippets](https://marketplace.visualstudio.com/items?itemName=abusaidm.html-snippets)
This extension adds many useful snippets for productivity. See for yourself:
![Example](images/HTML-Snippets-Example.gif)
#### [HTML CSS Support](https://marketplace.visualstudio.com/items?itemName=ecmel.vscode-html-css)
This will add great auto-completion for your project, including color-completion!
![HTML-CSS-Support](images/HTML_CSS_Extension.png)

### Pre-Builds
With Gitpod you can have your project built before you open your repository, no more waiting for all of those Node/Yarn dependencies to be built! Let's get started with building your project: To do this we need a [`.gitpod.yml`](https://www.gitpod.io/docs/41_config_gitpod_file/) file. Here is an example of what your start tasks should look like for a typical NPM project:
```YAML
tasks:
- init: npm install
command: npm start
```
For Yarn
```YAML
tasks:
- init: yarn && yarn build
command: yarn run
```
These should prebuild your workspace whenever you push a change!
Next let's talk about previewing your HTML pages without leaving the editor. To do this we must configure ports say your server listens on port 3000 in your [`.gitpod.yml`](https://www.gitpod.io/docs/41_config_gitpod_file/) file add this
```YAML
# Declare ports section
ports:
# Expose port 3000
- port: 3000
# Open preview after port opens
onOpen: open-preview
```
### Try It!

Want to try it out? And see a minimal example in action? Great, then you can open this in Gitpod:

[![JesterOrNot/Gitpod-Web-Development-Example](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/JesterOrNot/Gitpod-Web-Development-Example)
## External Resources
* [Start Tasks](https://www.gitpod.io/docs/44_config_start_tasks/)
* [Exposing Ports](https://www.gitpod.io/docs/43_config_ports/)
* [Theia](https://www.gitpod.io/docs/50_ide/)
* [Prebuilds](https://www.gitpod.io/docs/46_prebuilds/)
Binary file added src/docs/images/HTML-Snippets-Example.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/docs/images/HTML_CSS_Extension.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions src/docs/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@ export const MENU: MenuEntry[] = [
M(
"Go",
"go-in-gitpod"
),
M(
"HTML",
"html-in-gitpod"
)
]
),
Expand Down

0 comments on commit 690d24f

Please sign in to comment.