1
0
mirror of https://github.com/tabler/tabler.git synced 2026-07-24 20:14:39 +04:00

docs rebiuld

This commit is contained in:
codecalm
2021-02-17 21:56:48 +01:00
parent 21c1ae3bd7
commit 0c0d344107
15 changed files with 83 additions and 47 deletions
+31 -20
View File
@@ -1,13 +1,22 @@
index:
title: Introduction
url: docs/
hide-in-index: true
base: base:
title: Getting started title: Getting started
icon: brand-tabler # icon: brand-tabler
children: children:
index: getting-started:
title: Introduction title: Getting Started
url: docs/index.html url: docs/getting-started.html
usage: usage:
title: Usage title: Usage
url: docs/usage.html url: docs/usage.html
content:
title: Content
children:
colors: colors:
title: Colors title: Colors
url: docs/colors.html url: docs/colors.html
@@ -18,9 +27,22 @@ base:
title: Icons title: Icons
url: docs/icons.html url: docs/icons.html
forms:
title: Form components
# icon: forms
children:
form-elements:
title: Form elements
url: docs/form-elements.html
form-helpers:
title: Form helpers
url: docs/form-helpers.html
components: components:
title: Components title: Components
icon: puzzle columns: 2
# icon: puzzle
children: children:
alerts: alerts:
title: Alerts title: Alerts
@@ -52,12 +74,6 @@ components:
empty: empty:
title: Empty states title: Empty states
url: docs/empty.html url: docs/empty.html
form-elements:
title: Form elements
url: docs/form-elements.html
form-helpers:
title: Form helpers
url: docs/form-helpers.html
modals: modals:
title: Modals title: Modals
url: docs/modals.html url: docs/modals.html
@@ -103,27 +119,21 @@ components:
utils: utils:
title: Utilities title: Utilities
icon: flame # icon: flame
children: children:
borders: borders:
title: Borders title: Borders
url: docs/borders.html url: docs/borders.html
colors:
title: Colors
url: docs/colors.html
cursors: cursors:
title: Cursors title: Cursors
url: docs/cursors.html url: docs/cursors.html
interactions: interactions:
title: Interactions title: Interactions
url: docs/interactions.html url: docs/interactions.html
plugins: plugins:
title: Plugins title: Plugins
icon: apps # icon: apps
children: children:
autosize: autosize:
title: Autosize title: Autosize
@@ -144,5 +154,6 @@ plugins:
changelog: changelog:
title: Changelog title: Changelog
show-version: true show-version: true
icon: git-branch hide-in-index: true
# icon: git-branch
url: changelog.html url: changelog.html
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: Charts title: Charts
menu: docs.components.charts menu: docs.plugins.charts
--- ---
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: Colors title: Colors
menu: docs.utils.colors menu: docs.content.colors
description: The choice of colors for a website or app interface has an big influence on how users interact with the product and what decisions they make. Harmonic colors can contribute to a nice first impression and encourage users to engage with your product, so it's a very important aspect of a successful design, which needs to be well thought out. description: The choice of colors for a website or app interface has an big influence on how users interact with the product and what decisions they make. Harmonic colors can contribute to a nice first impression and encourage users to engage with your product, so it's a very important aspect of a successful design, which needs to be well thought out.
bootstrap-link: utilities/colors/ bootstrap-link: utilities/colors/
--- ---
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: Flags title: Flags
menu: docs.components.flags menu: docs.plugins.flags
description: Thanks to the Tabler flags plug-in, you can create flags to visually represent countries or languages. Flags are often used in forms, as an element of a delivery address, phone number dialling code and many more. description: Thanks to the Tabler flags plug-in, you can create flags to visually represent countries or languages. Flags are often used in forms, as an element of a delivery address, phone number dialling code and many more.
plugin: flags plugin: flags
libs: tabler-flags libs: tabler-flags
+1 -1
View File
@@ -3,7 +3,7 @@ title: Form elements
description: Forms are one of the most important types of interaction with a website or app. Since their aim is to enable users to make a purchase, subscribe to a service or sign up to create an account, it's important to make sure they are easy to complete and help increase conversion rates. Use the available elements to create forms which are well-structured and user-friendly. description: Forms are one of the most important types of interaction with a website or app. Since their aim is to enable users to make a purchase, subscribe to a service or sign up to create an account, it's important to make sure they are easy to complete and help increase conversion rates. Use the available elements to create forms which are well-structured and user-friendly.
bootstrap-link: components/forms/ bootstrap-link: components/forms/
libs: nouislider libs: nouislider
menu: docs.components.form-elements menu: docs.forms.form-elements
--- ---
+1 -1
View File
@@ -1,7 +1,7 @@
--- ---
title: Form helpers title: Form helpers
description: A form helper can be used to provide users with additional information about the elements of a form that may be unclear. description: A form helper can be used to provide users with additional information about the elements of a form that may be unclear.
menu: docs.components.form-helpers menu: docs.forms.form-helpers
--- ---
@@ -1,21 +1,11 @@
--- ---
title: Introduction title: Getting started
menu: docs.base.index menu: docs.base.getting-started
icon: flag
redirect_from: docs.html
--- ---
## What is Tabler?
Tabler is a UI kit that speeds up the development process and makes it easier than ever! Built on the latest version of Bootstrap, it helps you create templates based on fully customizable and ready-to-use UI components, which can be used by both simple websites and sophisticated systems. With basic knowledge of HTML and CSS, youll be able to create dashboards that are fully functional and beautifully designed!
## What are the benefits? ## What are the benefits?
Tabler is a perfect solution if you want to create an interface which is not only user-friendly but also fully reponsive. Thanks to the big choice of ready-made components, you can customize your design and adapt it to the needs of even the most demanding users. On top of that, Tabler is an open source solution, continuously developed and improved by the open source community. Tabler is a perfect solution if you want to create an interface which is not only user-friendly but also fully responsive. Thanks to the big choice of ready-made components, you can customize your design and adapt it to the needs of even the most demanding users. On top of that, Tabler is an open source solution, continuously developed and improved by the open source community.
To start using Tabler, first you need to set up the environment.
## Set up the environment ## Set up the environment
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: Icons title: Icons
menu: docs.base.icons menu: docs.content.icons
--- ---
## Base icon ## Base icon
+27
View File
@@ -0,0 +1,27 @@
---
title: Introduction
menu: docs.index
redirect_from: docs.html
---
<p>Tabler is a UI kit that speeds up the development process and makes it easier than ever! Built on the latest version of Bootstrap, it helps you create templates based on fully customizable and ready-to-use UI components, which can be used by both simple websites and sophisticated systems. With basic knowledge of HTML and CSS, youll be able to create dashboards that are fully functional and beautifully designed!</p>
<div class="mt-4">
<div class="row">
{% for doc in site.data.docs %}
{% unless doc[1].hide-in-index %}
<div class="{% if doc[1].columns == 2 %}col-12{% else %}col-sm-6{% endif %}">
<h3>{{ doc[1].title }}</h3>
<ul class="list-unstyled{% if doc[1].columns %} columns-md-{{ doc[1].columns }}{% endif %}">
{% for item in doc[1].children %}
<li>
- <a href="{{ site.base }}{{ item[1].url | relative_url }}">{{ item[1].title }}</a>
</li>
{% endfor %}
</ul>
</div>
{% endunless %}
{% endfor %}
</div>
</div>
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: Payments title: Payments
menu: docs.components.payments menu: docs.plugins.payments
description: The Tabler payments plug-in will let you use a set of payment provider icons to facilitate the payment process and make it more-user friendly. description: The Tabler payments plug-in will let you use a set of payment provider icons to facilitate the payment process and make it more-user friendly.
plugin: payments plugin: payments
--- ---
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
title: Typography title: Typography
menu: docs.base.typography menu: docs.content.typography
description: Typography plays an important role in creating an attractive and clear interface design. Good typography will make the content easy to follow and improve the usability of your website. description: Typography plays an important role in creating an attractive and clear interface design. Good typography will make the content easy to follow and improve the usability of your website.
bootstrap-link: content/typography/ bootstrap-link: content/typography/
--- ---
+1 -1
View File
@@ -1,6 +1,6 @@
{% assign current-menu = page.menu | split: '.' %} {% assign current-menu = page.menu | split: '.' %}
<ul class="nav nav-vertical"> <ul class="nav nav-pills nav-vertical">
{% for doc in site.data.docs %} {% for doc in site.data.docs %}
<li class="nav-item"> <li class="nav-item">
{% assign key = doc[0] %} {% assign key = doc[0] %}
+2 -2
View File
@@ -7,7 +7,7 @@ page-header: Documentation
{% assign current-url = page.url | replace_regex: "^/", "" %} {% assign current-url = page.url | replace_regex: "^/", "" %}
<div class="row"> <div class="row gx-lg-4">
<div class="d-none d-lg-block col-lg-3"> <div class="d-none d-lg-block col-lg-3">
{% include docs/menu.html %} {% include docs/menu.html %}
</div> </div>
@@ -21,7 +21,7 @@ page-header: Documentation
{% if page.bootstrap-link %} {% if page.bootstrap-link %}
<p class="ms-auto"> <p class="ms-auto">
<a href="https://getbootstrap.com/docs/4.4/{{ page.bootstrap-link }}" target="_blank"> <a href="https://getbootstrap.com/docs/5.0/{{ page.bootstrap-link }}" target="_blank" class="d-flex align-items-center">
{% include ui/icon.html icon="external-link" color="blue" class="pe-1" %} {% include ui/icon.html icon="external-link" color="blue" class="pe-1" %}
Bootstrap documentation Bootstrap documentation
</a> </a>
+6
View File
@@ -102,4 +102,10 @@ $utilities: (
class: h, class: h,
values: $size-values values: $size-values
), ),
"columns": (
property: columns,
class: columns,
responsive: true,
values: 2 3 4
)
) !default; ) !default;
+2
View File
@@ -3,6 +3,7 @@ Markdown
*/ */
.markdown { .markdown {
line-height: $line-height-lg; line-height: $line-height-lg;
font-size: $h4-font-size;
> :first-child { > :first-child {
margin-top: 0; margin-top: 0;
@@ -17,6 +18,7 @@ Markdown
h1, h2, h3, h4, h5, h6 { h1, h2, h3, h4, h5, h6 {
margin-top: 2rem; margin-top: 2rem;
margin-bottom: .5rem; margin-bottom: .5rem;
font-weight: $font-weight-bold;
} }
h1 { h1 {