diff --git a/README.md b/README.md index 90c0c908c..73300e7b8 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ A premium and open source dashboard template with a responsive and high-quality ![Tabler preview](/static/tabler-preview.png?raw=true) + ## Status Total Downloads License Latest Release @@ -13,6 +14,7 @@ A premium and open source dashboard template with a responsive and high-quality [![Backers on Open Collective](https://opencollective.com/tabler/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/tabler/sponsors/badge.svg)](#sponsors) + ## Features We've created this admin panel for everyone who wants to create templates based on our pre-made components. Our mission is to deliver a user-friendly, clear and easy administration panel that can be used by both simple websites and sophisticated systems. The only requirement is basic HTML and CSS (and some [Liquid](https://github.com/Shopify/liquid/wiki)) knowledge — as a reward, you'll be able to manage and visualise different types of data in the easiest possible way! @@ -24,10 +26,12 @@ We've created this admin panel for everyone who wants to create templates based * **Demo pages**: Tabler features over 20 individual pages using various components, which gives you the freedom to choose and combine. All components can vary in color and styling that you can easily modify using Sass. Sky is the limit! * **Single Page Application versions:** [Tabler React](https://github.com/tabler/tabler-react) has React components for Tabler. + ## Sponsor Tabler Sponsor Tabler + ## Setup environment To use our build system and run our documentation locally, you'll need a copy of Tabler's source files. Follow the steps below: @@ -45,6 +49,7 @@ To use our build system and run our documentation locally, you'll need a copy of Once you complete the setup, you'll be able to run the various commands provided from the command line. + ## Build locally 1. From the root `/tabler` directory, run `npm run start` in the command line. @@ -55,14 +60,17 @@ Once you complete the setup, you'll be able to run the various commands provided Run `npm run build` for reforms a one off build application without refresh. Open [http://localhost:3001](http://localhost:3001) to configure the Web server. + ## Feature requests https://tabler.canny.io/feature-requests + ## Bugs and feature requests Found a bug or have a feature request? [Please open a new issue](https://github.com/tabler/tabler/issues/new). + ## Creators **Paweł Kuna** @@ -71,11 +79,13 @@ Found a bug or have a feature request? [Please open a new issue](https://github. - - + ## Contributors This project exists thanks to all the people who contribute. [[Contribute](https://github.com/tabler/tabler/graphs/contributors)]. + ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tabler#backer)] @@ -98,6 +108,7 @@ Support this project by becoming a sponsor. Your logo will be displayed here wit + ## Copyright and license Code and documentation copyright 2018 the [Tabler Authors](https://github.com/tabler/tabler/graphs/contributors) and [codecalm.net](https://codecalm.net). Code released under the [MIT License](https://github.com/tabler/tabler/blob/master/LICENSE). diff --git a/pages/_docs/alerts.md b/pages/_docs/alerts.md index cc23cf914..ba01d688b 100644 --- a/pages/_docs/alerts.md +++ b/pages/_docs/alerts.md @@ -5,6 +5,7 @@ description: Bootstrap provides an easy way to create predefined alert messages. bootstrap-link: components/alerts/ --- + ## Default markup {% capture code %} @@ -45,6 +46,7 @@ Add the `alert-link` class to any links inside the alert box to create "matching {% endcapture %} {% include example.html code=code %} + ## Alerts with icons {% capture code %} @@ -57,6 +59,7 @@ Add the `alert-link` class to any links inside the alert box to create "matching {% endcapture %} {% include example.html code=code %} + ## Alert with avatar {% capture code %} @@ -69,6 +72,7 @@ Add the `alert-link` class to any links inside the alert box to create "matching {% endcapture %} {% include example.html code=code %} + ## Alert with buttons {% capture code %} diff --git a/pages/_docs/autosize.md b/pages/_docs/autosize.md index 2dcf8389f..a1e394383 100644 --- a/pages/_docs/autosize.md +++ b/pages/_docs/autosize.md @@ -5,6 +5,7 @@ description: A small, stand-alone script to automatically adjust textarea height done: true --- + ## Default markup {% capture code %} diff --git a/pages/_docs/avatars.md b/pages/_docs/avatars.md index b58944cd7..f61e5f83a 100644 --- a/pages/_docs/avatars.md +++ b/pages/_docs/avatars.md @@ -4,6 +4,7 @@ menu: docs.avatars description: Create and group avatars of various shapes and sizes with one component. --- + ## Default markup {% capture code %} @@ -13,6 +14,7 @@ description: Create and group avatars of various shapes and sizes with one compo {% endcapture %} {% include example.html code=code centered=true %} + ## Avatar image Set an image as the background. @@ -24,6 +26,7 @@ Set an image as the background. {% endcapture %} {% include example.html code=code centered=true %} + ## Initials You can easily use initials instead of images. @@ -37,6 +40,7 @@ You can easily use initials instead of images. {% endcapture %} {% include example.html code=code centered=true %} + ## Avatar icons You can also use icons in avatars. @@ -48,6 +52,7 @@ You can also use icons in avatars. {% endcapture %} {% include example.html code=code centered=true %} + ## Avatar initials color Customize the color of the avatars' background. You can click [here]({% docs_url colors %}) to see the list of available colors. @@ -61,6 +66,7 @@ Customize the color of the avatars' background. You can click [here]({% docs_url {% endcapture %} {% include example.html code=code centered=true %} + ## Avatar size Using Bootstrap’s typical naming structure, you can create a standard avatar, or scale it up to different sizes based on what’s needed. @@ -74,6 +80,7 @@ Using Bootstrap’s typical naming structure, you can create a standard avatar, {% endcapture %} {% include example.html code=code centered=true %} + ## Avatar status Add an online or offline status indicator to show user's availability. @@ -88,6 +95,7 @@ Add an online or offline status indicator to show user's availability. {% endcapture %} {% include example.html code=code centered=true %} + ## Avatar shape Change the shape of an avatar with the default Bootstrap image classes. @@ -101,6 +109,7 @@ Change the shape of an avatar with the default Bootstrap image classes. {% endcapture %} {% include example.html code=code centered=true %} + ## Avatars list You can easily create a list of avatars. @@ -110,6 +119,7 @@ You can easily create a list of avatars. {% endcapture %} {% include example.html code=code centered=true %} + ## Stacked list Make the list stack when it reaches a certain length. diff --git a/pages/_docs/badges.md b/pages/_docs/badges.md index fc449d6b6..48fe864d6 100644 --- a/pages/_docs/badges.md +++ b/pages/_docs/badges.md @@ -5,6 +5,7 @@ description: A small count and labeling component. bootstrap-link: components/badge/ --- + ## Default markup {% capture code %} @@ -14,6 +15,7 @@ bootstrap-link: components/badge/ {% endcapture %} {% include example.html code=code centered=true %} + ## Pill badges To make a pill bagde (with rounded corners) add `.bagde-pill` class. @@ -61,6 +63,7 @@ If you don't want your badge to contain any text you can do it by leaving the ht {% endcapture %} {% include example.html code=code centered=true %} + ### Badge addons You can add badge addon by adding `.badge-addon` class. @@ -72,6 +75,7 @@ You can add badge addon by adding `.badge-addon` class. {% endcapture %} {% include example.html code=code %} + ### Badge avatars If you want to add an avatar to your badge just create `.badge-avatar` class. diff --git a/pages/_docs/breadcrumb.md b/pages/_docs/breadcrumb.md index d70b9d160..7233e1fc8 100644 --- a/pages/_docs/breadcrumb.md +++ b/pages/_docs/breadcrumb.md @@ -7,7 +7,7 @@ bootstrap-link: components/breadcrumb/ ## Default markup - + The dividers are automatically created in the content of the `:before` pseudo-element of li tags. You can inform the current page using the `active` modifier in a `li` tag. It will disable the navigation of inner links. {% capture code %} @@ -15,6 +15,7 @@ The dividers are automatically created in the content of the `:before` pseudo-el {% endcapture %} {% include example.html code=code centered=true %} + ## Breadcrumb variations You can add more variations by modify `$breadcrumb-variants` variable in Tabler config. @@ -34,6 +35,7 @@ You can add more variations by modify `$breadcrumb-variants` variable in Tabler {% endcapture %} {% include example.html code=code centered=true %} + ## Alternate version {% capture code %} diff --git a/pages/_docs/buttons.md b/pages/_docs/buttons.md index 024d140de..97de667f1 100644 --- a/pages/_docs/buttons.md +++ b/pages/_docs/buttons.md @@ -6,6 +6,7 @@ bootstrap-link: components/buttons/ done: true --- + ## Button tag The `.btn` classes are designed to be used with the `