> For the complete documentation index, see [llms.txt](https://docs.tenten.co/awesome/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tenten.co/awesome/marketing/awesome-hubspot-cms/readme-en.md). # HubSpot CMS Boilerplate A straight-forward starting point for building a great website on the HubSpot CMS. [Documentation](https://github.com/HubSpot/cms-theme-boilerplate/wiki) | [Demo website](https://boilerplate.hubspotcms.com/) | [Contributing](https://github.com/HubSpot/cms-theme-boilerplate/blob/main/CONTRIBUTING.md) [![Current version](https://img.shields.io/github/v/release/HubSpot/cms-theme-boilerplate)](https://github.com/HubSpot/cms-theme-boilerplate/releases) [![Latest commit](https://img.shields.io/github/last-commit/HubSpot/cms-theme-boilerplate)](https://github.com/HubSpot/cms-theme-boilerplate/commits/main) [![Contributors](https://img.shields.io/github/contributors/HubSpot/cms-theme-boilerplate?logo=blue)](https://github.com/HubSpot/cms-theme-boilerplate/graphs/contributors) [![GitHub watchers](https://img.shields.io/github/watchers/HubSpot/cms-theme-boilerplate?style=social)](https://github.com/HubSpot/cms-theme-boilerplate/watchers) [![GitHub stars](https://img.shields.io/github/stars/HubSpot/cms-theme-boilerplate?style=social)](https://github.com/HubSpot/cms-theme-boilerplate/stargazers) [![GitHub forks](https://img.shields.io/github/forks/HubSpot/cms-theme-boilerplate?style=social)](https://github.com/HubSpot/cms-theme-boilerplate/network/members) [![HubSpot website grader score](https://img.shields.io/badge/HubSpot%20website%20grader%20score-97-brightgreen)](https://website.grader.com/tests/boilerplate.hubspotcms.com) [![Google Lighthouse desktop performance score](https://img.shields.io/badge/Google%20Lighthouse%20desktop%20performance%20score-98-brightgreen)](https://developers.google.com/web/tools/lighthouse) [![Google Lighthouse SEO score](https://img.shields.io/badge/Google%20Lighthouse%20SEO%20score-100-brightgreen)](https://developers.google.com/web/tools/lighthouse) [![Google Lighthouse accessibility score](https://img.shields.io/badge/Google%20Lighthouse%20accessibility%20score-100-brightgreen)](https://developers.google.com/web/tools/lighthouse) [![License](https://img.shields.io/badge/license-Apache%20Version%202.0-red)](https://github.com/HubSpot/cms-theme-boilerplate/blob/main/LICENSE) ## Purpose The [HubSpot CMS Boilerplate](https://designers.hubspot.com/docs/building-blocks/themes/hubspot-cms-boilerplate) is designed to offer developers a head start in the website building process. While the HubSpot CMS Boilerplate represents HubSpot's opinionated best practices, we intend to learn from similar projects and feedback. We hope it offers inspiration and utility for all website projects! ## Getting started ### To download the HubSpot CMS Boilerplate using the HubSpot CMS CLI: Before getting started, you will need to have [Node.js](https://nodejs.org) installed, the [HubSpot CMS CLI](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development#install-dependencies) installed, and we strongly suggest that you set up a [HubSpot CMS Developer Sandbox](https://offers.hubspot.com/free-cms-developer-sandbox) for your QA/testing environment. 1. Navigate to the directory that you want to use for your project 2. Run `hs create website-theme ` to create a project from the HubSpot CMS Boilerplate 3. [Configure](https://developers.hubspot.com/docs/cms/guides/getting-started-with-local-development#configure-the-local-development-tools) the local development tools for the portal(s) you'd like to use for your project. 4. Run `hs watch --portal= src --initial-upload` to upload all the files in the project and [watch for changes](https://developers.hubspot.com/docs/cms/developer-reference/local-development-cms-cli#watch) to files in the `src` directory Please reference our [*Quick start guide to developing on the HubSpot CMS*](https://developers.hubspot.com/docs/cms/guides/getting-started) and our [*Getting started with local development*](https://designers.hubspot.com/tutorials/getting-started-with-local-development) articles for more information. ### To use version control in your project using GitHub and GitHub Actions: 1. [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the HubSpot CMS Boilerplate repository and [clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) your forked repository to your computer 2. [Set up GitHub secrets in your forked repository to encrypt sensitive information from showing publically](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) for `HUBSPOT_PORTAL_ID` and `HUBSPOT_PERSONAL_ACCESS_KEY` 3. Update the name of the directory that you'll be deploying to in your Design Manager in the `.github/workflows/deploy.yml` file (the current default `dest_dir` is `cms-theme-boilerplate`) 4. Deploy changes to your Design Manager by pushing to the `main` branch of your forked repository Please reference our [*HubSpot CMS deploy GitHub action page*](https://github.com/marketplace/actions/hubspot-cms-deploy) and [*Setting up continuous integration with a GitHub repository using GitHub Actions article*](https://designers.hubspot.com/tutorials/github-integration) for more information. ## Style guide For details about the HubSpot CMS Boilerplate's recommended best practices and code formatting, please reference our [style guide](https://github.com/HubSpot/cms-theme-boilerplate/blob/master/STYLEGUIDE.md). ## Contributing If you’re interested in contributing to the HubSpot CMS Boilerplate, please read [CONTRIBUTING.md](https://github.com/HubSpot/cms-theme-boilerplate/blob/master/CONTRIBUTING.md) and [STYLEGUIDE.md](https://github.com/HubSpot/cms-theme-boilerplate/blob/master/STYLEGUIDE.md) to see how you can report an issue, make a feature request, or make a pull request. ## Versioning Previous releases and their documentation are available for [download](https://github.com/HubSpot/cms-theme-boilerplate/releases). To provide transparency into future releases, we create a project board that documents our planning in preparation for each [upcoming major and minor version](https://github.com/HubSpot/cms-theme-boilerplate/projects). ## Community You can stay up to date with HubSpot CMS Boilerplate updates and discussions in the #hs-cms-boilerplate channel in the [HubSpot Developer Slack](https://designers.hubspot.com/slack). ## License The code is available under the [Apache License, Version 2.0](https://github.com/HubSpot/cms-theme-boilerplate/blob/main/LICENSE) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.tenten.co/awesome/marketing/awesome-hubspot-cms/readme-en.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.