Skip to content

Commit be0b918

Browse files
committed
feat: initial commit
0 parents  commit be0b918

File tree

200 files changed

+10613
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

200 files changed

+10613
-0
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: "✨ Feature your project"
3+
about: Are you building with WebContainer API? Tell us about it!
4+
title: "[✨ Project submission]"
5+
labels: documentation
6+
assignees: sylwiavargas
7+
8+
---
9+
10+
Are you building with WebContainer API? Let's celebrate it 🥳
11+
Let us know and we'll feature it on our website, blog, and/or social media!
12+
13+
---
14+
## Description
15+
Tell us a few words about your project.
16+
17+
## Link
18+
Provide a link or a few links to the project - a website, blog post, a talk, youtube, etc.
19+
20+
## Handles
21+
Provide a Twitter or GitHub handle of the author of the project.
22+
23+
---
24+
Please note that your submission must:
25+
- be in accordance with our [Code of Conduct](CODE_OF_CONDUCT.md),
26+
- relate to WebContainers,
27+
- feature a project which is still online.
+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: "\U0001FAB2 Bug report"
3+
about: Create a report to help us improve!
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: sylwiavargas
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots or screen recordings to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

.gitignore

+106
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
44+
# TypeScript v1 declaration files
45+
typings/
46+
47+
# TypeScript cache
48+
*.tsbuildinfo
49+
50+
# Optional npm cache directory
51+
.npm
52+
53+
# Optional eslint cache
54+
.eslintcache
55+
56+
# Microbundle cache
57+
.rpt2_cache/
58+
.rts2_cache_cjs/
59+
.rts2_cache_es/
60+
.rts2_cache_umd/
61+
62+
# Optional REPL history
63+
.node_repl_history
64+
65+
# Output of 'npm pack'
66+
*.tgz
67+
68+
# Yarn Integrity file
69+
.yarn-integrity
70+
71+
# dotenv environment variables file
72+
.env
73+
.env.test
74+
75+
# parcel-bundler cache (https://parceljs.org/)
76+
.cache
77+
78+
# Next.js build output
79+
.next
80+
81+
# Nuxt.js build / generate output
82+
.nuxt
83+
dist
84+
docs/build
85+
86+
# Gatsby files
87+
.cache/
88+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
89+
# https://nextjs.org/blog/next-9-1#public-directory-support
90+
# public
91+
92+
# vuepress build output
93+
.vitepress/dist
94+
docs/.vitepress/cache
95+
96+
# Serverless directories
97+
.serverless/
98+
99+
# FuseBox cache
100+
.fusebox/
101+
102+
# DynamoDB Local files
103+
.dynamodb/
104+
105+
# TernJS port file
106+
.tern-port

.prettierrc

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"useTabs": false,
3+
"singleQuote": true,
4+
"printWidth": 100
5+
}

.stackblitzrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"startCommand": "npm run dev"
3+
}

.vscode/extensions.json

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
// See https://go.microsoft.com/fwlink/?LinkId=827846
3+
// for the documentation about the extensions.json format
4+
"recommendations": [
5+
"Vue.volar"
6+
]
7+
}

CODE_OF_CONDUCT.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Code of conduct
2+
3+
## Introduction
4+
5+
We welcome contributions from folks from all skill levels and expertise. We are especially welcoming to new programmers and to folks who have a keen interest in growing as technical writers or DocOps engineers.
6+
7+
We are a community that prioritizes a harassment-free experience for everyone.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to **fostering a positive environment** include:
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experiences
15+
- Referring to people by their preferred pronouns and using gender-neutral pronouns when uncertain
16+
- Gracefully accepting constructive criticism
17+
- Focusing on what is best for the community
18+
- Showing empathy towards other community members
19+
20+
Examples of **unacceptable behavior** by participants include:
21+
22+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
23+
- Trolling, insulting/derogatory comments, and personal or political attacks
24+
- Public or private harassment
25+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
26+
- Other conduct which could reasonably be considered inappropriate in a professional setting
27+
- Dismissing or attacking inclusion-oriented requests
28+
29+
**We prioritize marginalized people's safety over privileged people's comfort.** We will not act on complaints regarding:
30+
31+
- ‘Reverse’ -isms, including ‘reverse racism,’ ‘reverse sexism,’ and ‘cisphobia’
32+
- Reasonable communication of boundaries, such as 'leave me alone,' 'go away,' or 'I’m not discussing this with you.'
33+
- Someone’s refusal to explain or debate social justice concepts
34+
- Criticisms of racist, sexist, cissexist, or otherwise oppressive behavior or assumptions
35+
36+
In community communication, we do not appreciate any form of aggression (passive aggression included) — please don't post if you can't be kind and empathetic. Be proactive about owning your mistakes and apologizing if you have a feeling or know that you impacted someone in a negative way.
37+
38+
## Attribution
39+
40+
This Code of Conduct is adapted from:
41+
42+
- [Write/Speak/Code](https://www.writespeakcode.com/code-of-conduct/)
43+
- [Dev.to](https://dev.to/code-of-conduct)

CONTRIBUTING.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
2+
# Contributor Manual
3+
4+
We welcome contributions from folks from all skill levels and expertise. We are especially welcoming to new programmers and to those with a keen interest in growing as technical writers or DocOps engineers.
5+
6+
---
7+
8+
## Before you begin
9+
10+
We expect contributors to abide by our underlying [Code of Conduct](CODE_OF_CONDUCT.md). All discussions connected to our docs must be kind, respectful, and harassment-free. We will not dignify PRs or other contributions created in the spirit of disregard for the Code of Conduct.
11+
12+
We believe that communication is the lifeblood of any Open Source project. Please use beginner-friendly language. It's very easy to misunderstand one another in asynchronous, text-based conversations. When in doubt, assume everyone has the best intentions but consider helping them do better with clarifying questions and kind feedback. Remember that for many people English is not their first language and in such communication, native English speakers are also expected to flex their "foreigner muscle".
13+
14+
---
15+
16+
## Types of Contributions
17+
18+
There are numerous ways to contribute to docs:
19+
20+
- **Share feedback**
21+
- Each docs page features a feedback tool at the bottom - you can use it to let us know what you think!
22+
- If you see something broken or think any section could be better or less confusing please [check if there's an issue for that already](https://github.com/stackblitz/webcontainer-docs/issues) and if not, feel free to [create one](https://github.com/stackblitz/webcontainer-docs/issues/new).
23+
- **Share ideas**
24+
- We want our docs to be delightful. If you have an idea on an improvement, reach out to us on [GitHub discussions](https://github.com/stackblitz/webcontainer-docs/discussions).
25+
- **Fix typos**
26+
- Use [Web Publisher](#content-updates-with-web-publisher) for a quick typo fix!
27+
- **Create demos**
28+
- We'd like to help our users see more examples of using WebContainer API. Would you like to create a demo? Before you do, please reach out to us on [GitHub discussions](https://github.com/stackblitz/webcontainer-docs/discussions).
29+
- **Fix an issue**
30+
- You see an issue with the docs platform you'd like to work on? Ask to be assigned to fix it. Before you start your work, please read our [contributing guide](CONTRIBUTING.md).
31+
- **Reviews**
32+
- Please feel free to check existing PRs and issues. Share your loving feedback, help the other contributor approach the task in a better way, spot lurking bugs, errors, and mistakes. You can use pr.new to that end - in the URL of the issue or PR, swap "github.com" with "pr.new" to spin up the environment and the preview.
33+
34+
Thank you for making our docs better!
35+
36+
### What makes good issue
37+
38+
When creating an issue, please include:
39+
40+
- a descriptive title,
41+
- a link to what this issue refers to (a page, an example, a section),
42+
- if applicable, a screenshot or screen recording,
43+
- explanation of why you think it is an issue,
44+
- if you have an idea, a possible solution,
45+
- ideally, external links that explain any advanced or lesser-known topics so others can learn from your issue.
46+
47+
Please raise issues in situations like the following:
48+
49+
- confusing, overwhelming, or incorrect explanation,
50+
- outdated examples,
51+
- vague or missing content,
52+
- demo or page request,
53+
- compromised accessibility,
54+
- anything broken: demo, page, url, image,
55+
56+
If what you want to say doesn't really fall into actionable "problem" or "improvement", you can **start a new Discussion topic**. For example, feel free to ask:
57+
58+
- Could we split this page into multiple smaller steps?
59+
- This navigation item doesn't fit where it is - could we move it somewhere else?
60+
- How could we make the docs site more (adjective)?
61+
62+
---

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 StackBlitz
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)