浏览代码

Add documentation for 3rd-party libraries and resources (#2356)

Co-authored-by: Kevin Papst <[email protected]>
Co-authored-by: Bartłomiej Gawęda <[email protected]>
Paweł Kuna 4 月之前
父节点
当前提交
f8075f69c0

+ 5 - 0
.changeset/wise-deers-refuse.md

@@ -0,0 +1,5 @@
+---
+"@tabler/docs": patch
+---
+
+Add documentation for 3rd-party libraries and resources

+ 7 - 0
docs/content/ui/getting-started/references.md

@@ -0,0 +1,7 @@
+---
+title: 3rd-party Libraries & Resources
+---
+
+Tabler uses the following open source resources:
+
+{% include "docs/open-source-resources.html" %}

+ 122 - 0
shared/data/open-source.json

@@ -0,0 +1,122 @@
+[
+  {
+    "name": "Bootstrap",
+    "url": "https://getbootstrap.com/",
+    "description": "The most popular front-end framework for developing responsive, mobile first projects on the web.",
+    "license": "MIT"
+  },
+  {
+    "name": "IMask",
+    "url": "https://imask.js.org/",
+    "description": "Vanilla JavaScript input masking library with support for various mask types and dynamic behavior.",
+    "license": "MIT"
+  },
+  {
+    "name": "Autosize",
+    "url": "https://www.jacklmoore.com/autosize/",
+    "description": "Automatically adjusts textarea height to fit text content.",
+    "license": "MIT"
+  },
+  {
+    "name": "ApexCharts",
+    "url": "https://apexcharts.com/",
+    "description": "Modern charting library offering interactive and responsive charts.",
+    "license": "MIT"
+  },
+  {
+    "name": "noUiSlider",
+    "url": "https://refreshless.com/nouislider/",
+    "description": "Lightweight JavaScript range slider with multi-touch support and extensive customization options.",
+    "license": "MIT"
+  },
+  {
+    "name": "CountUp.js",
+    "url": "https://inorganik.github.io/countUp.js/",
+    "description": "Animates numerical values by counting up to them.",
+    "license": "MIT"
+  },
+  {
+    "name": "List.js",
+    "url": "https://listjs.com/",
+    "description": "Adds search, sort, and flexibility to tables, lists, and various HTML elements.",
+    "license": "MIT"
+  },
+  {
+    "name": "Masonry",
+    "url": "https://masonry.desandro.com/",
+    "description": "JavaScript grid layout library that arranges elements optimally based on available vertical space.",
+    "license": "MIT"
+  },
+  {
+    "name": "Mapbox GL JS",
+    "url": "https://docs.mapbox.com/mapbox-gl-js/",
+    "description": "JavaScript library for interactive, customizable vector maps on the web.",
+    "license": "BSD-3-Clause"
+  },
+  {
+    "name": "Litepicker",
+    "url": "https://github.com/wakirin/Litepicker",
+    "description": "Lightweight, no-dependency date range picker.",
+    "license": "MIT"
+  },
+  {
+    "name": "Tom Select",
+    "url": "https://tom-select.js.org/",
+    "description": "Dynamic and framework-agnostic <select> UI control with autocomplete and keyboard navigation.",
+    "license": "Apache-2.0"
+  },
+  {
+    "name": "jsVectorMap",
+    "url": "https://jvm-docs.vercel.app/",
+    "description": "Lightweight JavaScript library for creating interactive maps and data visualizations.",
+    "license": "MIT"
+  },
+  {
+    "name": "Fslightbox",
+    "url": "https://fslightbox.com/",
+    "description": "Vanilla JavaScript plugin for displaying images and videos in a fullscreen lightbox.",
+    "license": "MIT"
+  },
+  {
+    "name": "HugeRTE",
+    "url": "https://hugerte.org/",
+    "description": "MIT-licensed fork of TinyMCE, a web-based JavaScript HTML WYSIWYG editor control.",
+    "license": "MIT"
+  },
+  {
+    "name": "Plyr",
+    "url": "https://plyr.io/",
+    "description": "Simple, accessible, and customizable HTML5, YouTube, and Vimeo media player.",
+    "license": "MIT"
+  },
+  {
+    "name": "Dropzone",
+    "url": "https://www.dropzone.dev/",
+    "description": "Open-source library that provides drag-and-drop file uploads with image previews.",
+    "license": "MIT"
+  },
+  {
+    "name": "Star Rating.js",
+    "url": "https://pryley.github.io/star-rating.js/",
+    "description": "Lightweight JavaScript library for rendering star ratings.",
+    "license": "MIT"
+  },
+  {
+    "name": "Coloris",
+    "url": "https://github.com/melloware/coloris-npm",
+    "description": "Lightweight and elegant color picker written in vanilla JavaScript.",
+    "license": "MIT"
+  },
+  {
+    "name": "Typed.js",
+    "url": "https://mattboldt.com/demos/typed-js/",
+    "description": "JavaScript library that types out sentences in a human-like manner.",
+    "license": "MIT"
+  },
+  {
+    "name": "Signature Pad",
+    "url": "https://github.com/szimek/signature_pad",
+    "description": "JavaScript library for drawing smooth signatures.",
+    "license": "MIT"
+  }
+]

+ 24 - 0
shared/includes/docs/open-source-resources.html

@@ -0,0 +1,24 @@
+<table class="table">
+	<tr>
+		<th>
+			Name
+		</th>
+		<th>
+			Description
+		</th>
+		<th>
+			License
+		</th>
+	</tr>
+	{% for resource in open-source %}
+	<tr>
+		<td>
+			<a href="{{ resource.url }}" target="_blank">
+				{{ resource.name }}
+			</a>
+		</td>
+		<td>{{ resource.description | escape }}</td>
+		<td>{{ resource.license }}</td>
+	</tr>
+	{% endfor %}
+</table>