diff --git a/README.md b/README.md index 1752a972f..d97e7981c 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,8 @@ We've created this admin panel for everyone who wants to create templates based Documentation is available as a part of Tabler preview: https://tabler.io/docs/ +To run the documentation site locally, follow instructions in the [Documentation README](https://github.com/tabler/tabler/blob/dev/site/README.md). + ## 🪴 Project Activity ![Alt](https://repobeats.axiom.co/api/embed/61d1db34446967b0848af68198a392067e0f5870.svg "Repobeats analytics image") diff --git a/site/README.md b/site/README.md index b25ab5206..accaac8e7 100644 --- a/site/README.md +++ b/site/README.md @@ -1 +1,34 @@ -# Tabler website and Docs +

+A premium and open source dashboard template with a responsive and high-quality UI.

+A premium and open source dashboard template with a responsive and high-quality UI. +

+ +## 📦 Setup environment + +To run our documentation locally, first follow the steps in the main [Tabler README](https://github.com/tabler/tabler/blob/dev/README.md) to set up dependencies. + +## Build documentation locally + +You need to have `pnpm` installed. + +1. From the `/tabler/site` directory, run `pnmp install` to install dependencies in the command line. +2. Then execute `pnpm run build` to build the Next site which holds Tabler documentation. +3. Execute `pnpm run start` to start the Next site. + - A success may look like + ``` + > start + > next start + + ▲ Next.js 13.5.3 + - Local: http://localhost:3000 + + ✓ Ready in 1513ms + + ``` +4. Open [http://localhost:3000](http://localhost:3000) in your browser to see the documentation site, a local version of [tabler.io/docs](https://tabler.io/docs). + +**Note**: *To see a full list of possible documentation site command line commands, go to `tabler/site/package.json`.* + +## License + +See the [LICENSE](https://github.com/tabler/tabler/blob/master/LICENSE) file.