https://github.com/stenciljs/site

Stencil site and documentation source.
https://github.com/stenciljs/site

documentation stenciljs

Last synced: about 1 month ago
JSON representation

Stencil site and documentation source.

• Host: GitHub
• URL: https://github.com/stenciljs/site
• Owner: stenciljs
• License: mit
• Created: 2017-06-23T03:09:30.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2025-05-05T18:45:47.000Z (about 2 months ago)
• Last Synced: 2025-05-05T19:30:23.121Z (about 2 months ago)
• Topics: documentation, stenciljs
• Language: TypeScript
• Homepage: https://stenciljs.com/
• Size: 16.8 MB
• Stars: 340
• Watchers: 20
• Forks: 421
• Open Issues: 36
• Metadata Files:
  • Readme: readme.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# Stencil Site

The [Stencil site](https://stenciljs.com/) is the place for documentation on how to use Stencil.

## Contributing Documentation Updates

The documentation content is formatted in markdown and can be found in the [docs directory](https://github.com/ionic-team/stencil-site/tree/master/docs). Easiest way to make edits is to navigate to the markdown file to be updated, and click the Edit button in the top right (the pencil icon). After making the edit, submitting the changes will create a Pull Request (PR) for reviewed. Please feel free to ask any questions within the [discord channel](https://chat.stenciljs.com/), we're happy to help.

## Building the Site

To build the site from the source, ensure you're using the most recent versions of Node and Npm, and pull the latest from master. Next, run `npm install`, `npm run docs` to build the docs files and `npm start` to launch the site in development mode.

## Related

 - [Stencil Documentation](https://stenciljs.com/)

 - [Ionic Discord](https://chat.stenciljs.com/)

 - [Ionic](https://ionicframework.com/)

 - [Ionicons](http://ionicons.com/)

 - [Capacitor](https://capacitor.ionicframework.com/)

## License

 - [MIT](https://raw.githubusercontent.com/ionic-team/stencil-site/master/LICENSE)