Getting Started
Welcome to Cosmic Themes Documentation
This documentation is for all themes by Cosmic Themes. While the themes handle a lot for you - SEO meta tags, sitemaps, RSS feeds, and more - you will at least want to update the text on the site, and potentially colors or individual components. These docs are designed to help you get started with your theme, and to help you customize it to your liking.
- To get started, first install all necessary packages with
npm install
, then run an initial build to make sure the setup worksnpm run build
. - Next, you’ll want to configure your site i18n setup (one language, or multiple). Follow instructions in the i18n documentation.
- Now you can setup the site to your liking!
- Finally, deploy to your provider of choice. We recommend Netlify, Vercel, or Cloudflare Pages. See the deployment documentation.
Code Tours
Every theme comes with a number of code tours to help introduce you to the codebase. You will need the extension Code Tour to view them in VSCode.
Support
We provide support for paying customers. This includes items such as how to change parts of a theme, issues with payment, any bugs, and more.
However: It is your responsibility to know how to use HTML, CSS, Tailwind, and Astro. Some resources to help you learn these are:
Please view the support page for more details and contact info.
License
In plain english: You can use our Themes for an unlimited amount of projects, including ones you sell, such as a personal website, a SaaS app, or a website for a client.
As long as you don’t build a product that will directly compete with Cosmic Themes, such as other themes, templates, UI kits, or page builders, it is probably fine!
You can view the full license details on the license page.