Skip to content

Latest commit

 

History

History
128 lines (89 loc) · 6.27 KB

README.md

File metadata and controls

128 lines (89 loc) · 6.27 KB
Raw

StackBlitz Docs

Welcome to the home of the StackBlitz documentation site!

Our docs site was built with VitePress 💙

What is StackBlitz?

StackBlitz is an instant fullstack web IDE for the JavaScript ecosystem. It is powered by WebContainers, the first WebAssembly-based operating system which boots Node.js environment in milliseconds, securely within your browser tab.

Now you can use the web to build the web.

In fact, why not edit this docs in Codeflow IDE?

Open in Codeflow

Let's make the docs better!

Thank you for visiting this repository. We love our community and we appreciate your time.

There are numerous ways to contribute to docs:

  • Share feedback
    • Each docs page features a feedback tool at the bottom - you can use it to let us know what you think!
    • 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 and if not, feel free to create one.
  • Share ideas
    • We want our docs to be delightful. If you have an idea on an improvement, reach out to us on GitHub discussions.
  • Fix typos
  • Create demos
    • We'd like to help our users see our SDK methods in action. Would you like to create a Vanilla JS or TS demo? Before you do, please read our contributing guide and reach out to us on GitHub discussions.
  • Fix an issue
    • You see an issue you'd like to work on? Ask to be assigned to fix it. Before you start your work, please read our contributing guide.
  • Reviews
    • 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.

Thank you for making our docs better!

What makes a good issue

When creating an issue, please include:

  • a descriptive title,
  • a link to what this issue refers to (a page, an example, a section),
  • if applicable, a screenshot or screen recording,
  • explanation of why you think it is an issue,
  • if you have an idea, a possible solution,
  • ideally, external links that explain any advanced or lesser-known topics so others can learn from your issue.

Please raise issues in situations like the following:

  • confusing, overwhelming, or incorrect explanation,
  • outdated examples,
  • vague or missing content,
  • demo or page request,
  • compromised accessibility,
  • anything broken: demo, page, url, image,

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:

  • Could we split this page into multiple smaller steps?
  • This navigation item doesn't fit where it is - could we move it somewhere else?
  • How could we make the docs site more (adjective)?

Development

There are three ways to interact with this repository:

Content updates with Web Publisher

Use Web Publisher for small content updates for a pleasant editing experience:

  1. Open any page on our docs site (Like this one), scroll down, and click "edit this page".
  2. Update the document in the editor on the left and see the rendered change in the preview window on the right.
  3. Once you're done, in the top right corner click on the green button that says "Propose changes".
  4. You will be redirected to a GitHub PR template page prepared for you to submit a PR.

Developing with StackBlitz Codeflow

Use StackBlitz Codeflow for bigger content updates. Codeflow will spin up the entire dev environment with a running dev server. When using Codeflow, please remember to commit and push your changes frequently.

To access it, click this button.

Alternatively, add “pr.new” to the beginning of this GitHub repository URL.

Developing locally

You can also explore and develop this site locally.

After cloning the repository, run the docs site in development mode with:

npm install
npm start

Editor setup

We have already equipped this repository with the suggested extension (Vue Language Features extension (Volar)). Additionally, you can use Volar’s Take Over Mode (aka disabling the built-in TypeScript and JavaScript Language Features extension for the current workspace).

Enable Algolia and Google Tag Manager

For production, the docs expect the following environment variables to be defined:

  • VITE_ALGOLIA_ID: Algolia appId.
  • VITE_ALGOLIA_KEY: Algolia apiKey.
  • VITE_GTM_ID: Google Tag Manager id.

They can be defined in CI configuration, or in a .env file:

# .env
VITE_ALGOLIA_ID='******'
VITE_ALGOLIA_KEY='******'
VITE_GTM_ID='******'

Join our community