Stencil

https://github.com/stenciljs/site

Admin

Stencil is a toolchain for building reusable, scalable, and performant design systems and web...

Tokens:2,012

Snippets:47

Trust Score:7.8

License:MIT

Update:3 months ago

Show doc for...

Tokens:

Raw

### Build and Serve Stencil Documentation

Source: https://github.com/stenciljs/site/blob/main/CONTRIBUTING.md

Run these commands after modifying documentation files to build the changes and serve the documentation locally for review.

```bash
npm run build
npm run serve
```

--------------------------------

### Serve Stencil Docs Locally

Source: https://github.com/stenciljs/site/blob/main/CONTRIBUTING.md

Run this command to serve the Stencil documentation site locally for development. Anchor links may not function correctly in this mode.

```bash
npm start
```

--------------------------------

### Serve Built Stencil Docs for Anchor Link Testing

Source: https://github.com/stenciljs/site/blob/main/CONTRIBUTING.md

Serve the built documentation site to test anchor links. This command should be used after running `npm run build`.

```bash
npm run serve
```

--------------------------------

### Build Stencil Docs for Anchor Link Testing

Source: https://github.com/stenciljs/site/blob/main/CONTRIBUTING.md

Build the documentation files before serving to test anchor links. This command generates the necessary files for a production-like build.

```bash
npm run build
```

--------------------------------

### Checkout Main Branch

Source: https://github.com/stenciljs/site/blob/main/RELEASE.md

Ensure you have the latest version of the main branch before generating a new release.

```bash
git checkout main && git pull
```

--------------------------------

### Generate New Docusaurus Version

Source: https://github.com/stenciljs/site/blob/main/RELEASE.md

Use this command to generate a new version section for the documentation site. Replace `[VERSION]` with the desired version number (e.g., v4.1).

```bash
npm run docusaurus docs:version v[VERSION]
```

--------------------------------

### Stencil Commit Message Format

Source: https://github.com/stenciljs/site/blob/main/CONTRIBUTING.md

Follow this format for commit messages to ensure consistency and readability in the project history. The type should be 'docs'.

```git commit
type(scope): subject
```

Tokens:

Raw