mirror of
https://github.com/anomalyco/opentui.git
synced 2026-09-19 01:26:03 +08:00
docs update
This commit is contained in:
Sebastian Herrlinger
@@ -6,9 +6,7 @@
|
||||
<a href="https://github.com/msmps/awesome-opentui"><img alt="awesome opentui list" src="https://awesome.re/badge-flat.svg" /></a>
|
||||
</div>
|
||||
|
||||
OpenTUI is a TypeScript library for building terminal user interfaces (TUIs). It is currently in
|
||||
development and is not ready for production use. It will be the foundational TUI framework for both
|
||||
[OpenCode](https://opencode.ai) and [terminaldotshop](https://terminal.shop).
|
||||
OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers [OpenCode](https://opencode.ai) in production today and will also power [terminal.shop](https://terminal.shop). It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.
|
||||
|
||||
Docs: https://opentui.com/docs/getting-started
|
||||
|
||||
@@ -20,7 +18,7 @@ bun create tui
|
||||
|
||||
This monorepo contains the following packages:
|
||||
|
||||
- [`@opentui/core`](packages/core) - The core library works completely standalone, providing an imperative API and all the primitives.
|
||||
- [`@opentui/core`](packages/core) - TypeScript bindings for OpenTUI's native Zig core, with an imperative API and all primitives.
|
||||
- [`@opentui/solid`](packages/solid) - The SolidJS reconciler for OpenTUI.
|
||||
- [`@opentui/react`](packages/react) - The React reconciler for OpenTUI.
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
# OpenTUI Core
|
||||
|
||||
OpenTUI Core is a TypeScript library for building terminal user interfaces (TUIs). It is currently in
|
||||
development and is not ready for production use.
|
||||
OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.
|
||||
|
||||
## Documentation
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Getting Started with OpenTUI
|
||||
|
||||
OpenTUI is a TypeScript library for building terminal user interfaces (TUIs). It provides a component-based architecture with flexible layout capabilities, allowing you to create complex console applications.
|
||||
OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.
|
||||
|
||||
## Core Concepts
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@opentui/core",
|
||||
"description": "OpenTUI is a TypeScript library for building terminal user interfaces (TUIs)",
|
||||
"description": "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/anomalyco/opentui",
|
||||
|
||||
@@ -6,7 +6,7 @@ order: 1
|
||||
|
||||
# Getting started
|
||||
|
||||
OpenTUI is a TypeScript library for building terminal user interfaces.
|
||||
OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ interface Props {
|
||||
|
||||
const {
|
||||
title,
|
||||
description = "TypeScript library for building terminal user interfaces"
|
||||
description = "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)"
|
||||
} = Astro.props
|
||||
---
|
||||
|
||||
|
||||
@@ -119,7 +119,7 @@ const isActive = (path: string) => currentPath === path || currentPath === `${pa
|
||||
|
||||
<footer class="footer">
|
||||
<div class="footer-content">
|
||||
<span>OpenTUI - Terminal UIs in TypeScript</span>
|
||||
<span>OpenTUI - Terminal UIs</span>
|
||||
<a href="https://github.com/anomalyco/opentui" target="_blank" rel="noopener noreferrer">GitHub</a>
|
||||
</div>
|
||||
</footer>
|
||||
|
||||
@@ -42,7 +42,7 @@ const features = [
|
||||
]
|
||||
---
|
||||
|
||||
<Base title="OpenTUI - Terminal UIs in TypeScript">
|
||||
<Base title="OpenTUI - Terminal UIs">
|
||||
<main class="landing">
|
||||
<div class="landing-container">
|
||||
<!-- Header -->
|
||||
@@ -87,9 +87,9 @@ const features = [
|
||||
<section class="hero">
|
||||
<div class="hero-content">
|
||||
<div class="hero-copy">
|
||||
<h1>Terminal UIs in TypeScript</h1>
|
||||
<h1>Terminal UIs on a Native Zig Core</h1>
|
||||
<p class="hero-subtitle">
|
||||
Build rich, interactive terminal interfaces with flexbox layouts and first-class TypeScript support.
|
||||
Build rich, interactive terminal interfaces with TypeScript bindings, first-class React/Solid support, and a C ABI for any language.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
@@ -229,7 +229,7 @@ renderer.root.<span class="function">add</span>(
|
||||
<section class="what-section">
|
||||
<div class="what-section-title">
|
||||
<h3>What is OpenTUI?</h3>
|
||||
<p>OpenTUI is a TypeScript library for building rich, interactive terminal user interfaces.</p>
|
||||
<p>OpenTUI is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. OpenTUI powers OpenCode in production today and will also power terminal.shop. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.</p>
|
||||
</div>
|
||||
|
||||
<div class="features-split">
|
||||
|
||||
Reference in New Issue
Block a user