Mirrors/tabler
1
0
Fork 0
mirror of https://github.com/tabler/tabler.git synced 2025-12-21 17:34:25 +04:00
Code Issues Projects Releases Wiki Activity

Adding documentation in Site and main README for how to run documentation site locally (#1734)

Browse Source
This commit is contained in:
Mira Tellegen
2023-10-20 04:43:41 -04:00
committed by GitHub
parent 72b72d94c6
commit 80de80bd4b
2 changed files with 36 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -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/ 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 ## 🪴 Project Activity
![Alt](https://repobeats.axiom.co/api/embed/61d1db34446967b0848af68198a392067e0f5870.svg "Repobeats analytics image") ![Alt](https://repobeats.axiom.co/api/embed/61d1db34446967b0848af68198a392067e0f5870.svg "Repobeats analytics image")

35
site/README.md
View File

@@ -1 +1,34 @@
# Tabler website and Docs <p align="center">
<a href="https://github.com/tabler/tabler"><img src="https://raw.githubusercontent.com/tabler/tabler/dev/src/static/logo.svg" alt="A premium and open source dashboard template with a responsive and high-quality UI." width="300"></a><br><br>
A premium and open source dashboard template with a responsive and high-quality UI.
</p>
## 📦 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.