first commit

xterminal/docs/index.md

@@ -0,0 +1,41 @@
+---
+layout: home
+
+hero:
+  name: XTerminal
+  text: Build Web-based Command-line Interfaces
+  tagline: Simple and perfomant front-end tool for building command-line interfaces in the browser.
+  image:
+    src: /logo.svg
+    alt: XTerminal Logo
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /guide/index
+    - theme: alt
+      text: Demo
+      link: /demo/index
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/henryhale/xterminal
+
+features:
+  - icon: 🚀
+    title: Performant
+    details: It is lightweight, fast and designed with performance in mind. This library offers efficient handling of user input, resulting in a responsive and smooth CLI experience.
+  - icon: 📦
+    title: Dependency-free
+    details: This library does not rely on any external dependencies to work, keeping your project lean and reducing the potential for conflicts or versioning issues. 
+  - icon: 🟩
+    title: Inspired by Node.js
+    details: Drawing inspiration from the readline module in Node.js, this library provides similar functionality for input/output management, enabling a smooth transition for developers familiar with Node.js CLI development.
+  - icon: 🖌️
+    title: Customizable
+    details: Tailor the appearance and behavior of your CLI to match your application's style and requirements. Customize colors, themes, fonts, and other visual aspects to create a unique and cohesive user experience.
+  - icon: 💎
+    title: Native text formatting
+    details: Enhance your CLI output with native web technologies (HTML & CSS) including styling, inline images, hyperlinks, and other visual enhancements.
+  - icon: 🔌
+    title: Event-driven API
+    details: Utilize an event-driven API to handle user input, execute commands, and respond to various events. Hook into events such as input, keypress, and completion to create dynamic and interactive CLI interactions.
+---