This project includes kite-chat docs static site built with Astro Starlight template and Tailwind CSS.
Components are built using Astro with TypeScript.
Install dependencies:
npm iThis project uses starlight integration for Astro to generate static docs website.
To generate the docs run:
npm run buildIt builds docs in production enviroment by default. To build test version run:
npm run build:testThe docs is generated from /src/content/docs directory.
To preview generated site run:
npm run previewAstro comes with a built-in development server that has everything you need for project development. The astro dev command will start the local development server so that you can see your website in action for the very first time.
To run the dev server and open the project in a new browser tab:
npm run devIt runs docs in development enviroment by default. To run test version run:
npm run dev:testLinting of TypeScript files is provided by ESLint and TypeScript ESLint. In addition, lit-analyzer is used to type-check and lint lit-html templates with the same engine and rules as lit-plugin.
The rules are mostly the recommended rules from each project, but some have been turned off to make LitElement usage easier. The recommended rules are pretty strict, so you may want to relax them by editing .eslintrc.json and tsconfig.json.
To lint the project run:
npm run lintPrettier is used for code formatting. It has been pre-configured according to the Lit's style. You can change this in .prettierrc.json.
Prettier has not been configured to run when committing files, but this can be added with Husky and and pretty-quick. See the prettier.io site for instructions.