mui 0.2.0 → 0.4.0

data/docs/configuration.md

@@ -0,0 +1,314 @@
+---
+title: Configuration
+layout: default
+nav_order: 4
+---
+
+# Configuration
+{: .no_toc }
+
+## Table of contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
+---
+
+## Configuration Files
+
+Mui supports two configuration files:
+
+| File | Scope |
+|------|-------|
+| `~/.muirc` | Global settings (all projects) |
+| `.lmuirc` | Local settings (current directory) |
+
+Local settings (`.lmuirc`) override global settings (`~/.muirc`).
+
+Configuration files are written in Ruby using Mui's DSL.
+
+## Basic Settings
+
+### Color Scheme
+
+```ruby
+Mui.set :colorscheme, "tokyo_night"
+```
+
+Available themes (all themes support 256-color palette with 8-color fallback):
+
+| Theme | Description |
+|-------|-------------|
+| `mui` | Default theme with eye-friendly gray-based colors |
+| `solarized_dark` | Solarized dark theme |
+| `solarized_light` | Solarized light theme |
+| `monokai` | Monokai theme |
+| `nord` | Nord theme |
+| `gruvbox_dark` | Gruvbox dark theme |
+| `dracula` | Dracula theme |
+| `tokyo_night` | Tokyo Night theme |
+
+### 256-Color Support
+
+All bundled themes utilize 256-color palettes for rich syntax highlighting and UI elements. Mui automatically detects your terminal's color capabilities:
+
+- **256-color terminals**: Full color palette with all theme colors
+- **8-color terminals**: Automatic fallback to basic 8-color equivalents
+
+Most modern terminals (iTerm2, gnome-terminal, Windows Terminal, etc.) support 256 colors. If colors appear incorrect, ensure your terminal's `TERM` environment variable is set correctly (e.g., `xterm-256color`).
+
+### Indentation
+
+```ruby
+# Number of spaces for Tab display
+Mui.set :tabstop, 4
+
+# Number of spaces for indent operations (>, <)
+Mui.set :shiftwidth, 4
+
+# Use spaces instead of tabs
+Mui.set :expandtab, true
+```
+
+### Syntax Highlighting
+
+```ruby
+# Enable/disable syntax highlighting
+Mui.set :syntax, true
+```
+
+### Leader Key
+
+```ruby
+# Set leader key (default: backslash)
+Mui.set :leader, " "  # Space as leader
+```
+
+### Key Timeout
+
+```ruby
+# Timeout for multi-key sequences (milliseconds)
+Mui.set :timeoutlen, 1000
+```
+
+---
+
+## Custom Key Mappings
+
+Define custom key bindings with `Mui.keymap`:
+
+```ruby
+Mui.keymap :mode, "key" do |ctx|
+  # action
+end
+```
+
+### Modes
+
+- `:normal` - Normal mode
+- `:insert` - Insert mode
+- `:visual` - Visual mode
+- `:command` - Command mode
+
+### Examples
+
+```ruby
+# Save with <Leader>w
+Mui.keymap :normal, "<Leader>w" do |ctx|
+  ctx.editor.execute_command("w")
+end
+
+# Quick escape in Insert mode
+Mui.keymap :insert, "jk" do |ctx|
+  ctx.change_mode(:normal)
+end
+
+# Close buffer with <Leader>q
+Mui.keymap :normal, "<Leader>q" do |ctx|
+  ctx.editor.execute_command("q")
+end
+```
+
+### Special Key Notation
+
+| Notation | Key |
+|----------|-----|
+| `<Leader>` | Leader key |
+| `<Space>` | Space bar |
+| `<Tab>` | Tab key |
+| `<S-Tab>`, `<btab>` | Shift+Tab |
+| `<CR>`, `<Enter>` | Enter key |
+| `<Esc>` | Escape key |
+| `<BS>` | Backspace |
+| `<C-x>` | Ctrl+x |
+| `<C-S-x>` | Ctrl+Shift+x |
+| `<S-x>` | Shift+x |
+
+### Multi-key Sequences
+
+```ruby
+# <Leader>ff for find files
+Mui.keymap :normal, "<Leader>ff" do |ctx|
+  ctx.editor.execute_command("Files")
+end
+
+# <Leader>fg for grep
+Mui.keymap :normal, "<Leader>fg" do |ctx|
+  ctx.editor.execute_command("Rg")
+end
+
+# Ctrl-x Ctrl-s to save (Emacs style)
+Mui.keymap :normal, "<C-x><C-s>" do |ctx|
+  ctx.editor.execute_command("w")
+end
+```
+
+---
+
+## Custom Commands
+
+Define custom Ex commands with `Mui.command`:
+
+```ruby
+Mui.command :name do |ctx|
+  # action
+end
+```
+
+### Examples
+
+```ruby
+# Simple greeting
+Mui.command :hello do |ctx|
+  ctx.set_message("Hello, World!")
+end
+
+# Command with arguments
+Mui.command :echo do |ctx, *args|
+  ctx.set_message(args.join(" "))
+end
+
+# Open configuration file
+Mui.command :config do |ctx|
+  ctx.editor.execute_command("e ~/.muirc")
+end
+```
+
+---
+
+## Autocmd Events
+
+Execute code when events occur with `Mui.autocmd`:
+
+```ruby
+Mui.autocmd :event, pattern: "*.ext" do |ctx|
+  # action
+end
+```
+
+### Available Events
+
+| Event | Trigger |
+|-------|---------|
+| `BufEnter` | When entering a buffer |
+| `BufLeave` | When leaving a buffer |
+| `BufWrite` | When writing a buffer |
+| `BufWritePre` | Before writing a buffer |
+| `BufWritePost` | After writing a buffer |
+| `ModeChanged` | When mode changes |
+| `CursorMoved` | When cursor moves |
+| `TextChanged` | When text is modified |
+| `InsertEnter` | When entering Insert mode |
+| `InsertLeave` | When leaving Insert mode |
+| `InsertCompletion` | When completion is triggered |
+| `JobStarted` | When a job starts |
+| `JobCompleted` | When a job completes |
+| `JobFailed` | When a job fails |
+| `JobCancelled` | When a job is cancelled |
+
+### Examples
+
+```ruby
+# Auto-save on leaving Insert mode
+Mui.autocmd :InsertLeave do |ctx|
+  ctx.editor.execute_command("w") if ctx.buffer.modified?
+end
+
+# Show message when opening Ruby files
+Mui.autocmd :BufEnter, pattern: "*.rb" do |ctx|
+  ctx.set_message("Ruby file loaded")
+end
+
+# Format before saving
+Mui.autocmd :BufWritePre, pattern: "*.rb" do |ctx|
+  # Run formatter
+end
+```
+
+---
+
+## Using Plugins
+
+Load plugins with `Mui.use`:
+
+```ruby
+Mui.use "mui-lsp"
+Mui.use "mui-git"
+Mui.use "mui-fzf"
+```
+
+See [Plugins]({{ site.baseurl }}/plugins) for more details.
+
+---
+
+## Complete Example
+
+```ruby
+# ~/.muirc
+
+# Appearance
+Mui.set :colorscheme, "tokyo_night"
+Mui.set :syntax, true
+
+# Indentation
+Mui.set :tabstop, 2
+Mui.set :shiftwidth, 2
+Mui.set :expandtab, true
+
+# Leader key
+Mui.set :leader, " "
+
+# Plugins
+Mui.use "mui-lsp"
+Mui.use "mui-fzf"
+
+# Key mappings
+Mui.keymap :normal, "<Leader>w" do |ctx|
+  ctx.editor.execute_command("w")
+end
+
+Mui.keymap :normal, "<Leader>q" do |ctx|
+  ctx.editor.execute_command("q")
+end
+
+Mui.keymap :normal, "<Leader>ff" do |ctx|
+  ctx.editor.execute_command("Files")
+end
+
+# Custom commands
+Mui.command :reload do |ctx|
+  ctx.editor.execute_command("e")
+  ctx.set_message("File reloaded")
+end
+
+# LSP configuration
+Mui.lsp do
+  use :ruby
+
+  # TypeScript (requires typescript-language-server)
+  server :typescript,
+    command: ["typescript-language-server", "--stdio"],
+    filetypes: ["typescript", "typescriptreact", "javascript", "javascriptreact"]
+end
+```

data/docs/getting-started.md

@@ -0,0 +1,140 @@
+---
+title: Getting Started
+layout: default
+nav_order: 2
+---
+
+# Getting Started
+{: .no_toc }
+
+## Table of contents
+{: .no_toc .text-delta }
+
+1. TOC
+{:toc}
+
+---
+
+## Installation
+
+Install Mui from RubyGems:
+
+```bash
+gem install mui
+```
+
+### Requirements
+
+- Ruby 3.0 or later
+- A terminal that supports 256 colors
+
+## Basic Usage
+
+### Opening a File
+
+```bash
+mui filename.rb
+```
+
+### Creating a New File
+
+```bash
+mui
+```
+
+Or open a non-existent file path:
+
+```bash
+mui new_file.rb
+```
+
+## Modes
+
+Mui is a modal editor, similar to Vim. Understanding modes is essential.
+
+### Normal Mode
+
+The default mode. Used for navigation and commands.
+
+- Press `Esc` from any mode to return to Normal mode
+
+### Insert Mode
+
+For typing text. Enter from Normal mode with:
+
+| Key | Action |
+|-----|--------|
+| `i` | Insert before cursor |
+| `a` | Append after cursor |
+| `o` | Open new line below |
+| `O` | Open new line above |
+
+### Visual Mode
+
+For selecting text:
+
+| Key | Action |
+|-----|--------|
+| `v` | Character-wise selection |
+| `V` | Line-wise selection |
+
+### Command Mode
+
+For Ex commands. Press `:` from Normal mode.
+
+## Essential Commands
+
+### Saving and Quitting
+
+| Command | Action |
+|---------|--------|
+| `:w` | Save file |
+| `:q` | Quit (fails if unsaved changes) |
+| `:q!` | Force quit without saving |
+| `:wq` | Save and quit |
+
+### Opening Files
+
+| Command | Action |
+|---------|--------|
+| `:e filename` | Open file |
+| `:sp filename` | Open in horizontal split |
+| `:vs filename` | Open in vertical split |
+| `:tabnew filename` | Open in new tab |
+
+### Navigation
+
+| Key | Action |
+|-----|--------|
+| `h`, `j`, `k`, `l` | Left, down, up, right |
+| `w`, `b` | Word forward, backward |
+| `0`, `$` | Line start, end |
+| `gg`, `G` | File start, end |
+| `/pattern` | Search forward |
+| `?pattern` | Search backward |
+| `n`, `N` | Next, previous match |
+
+## Configuration
+
+Create `~/.muirc` for global settings:
+
+```ruby
+# Set color scheme
+Mui.set :colorscheme, "tokyo_night"
+
+# Enable syntax highlighting
+Mui.set :syntax, true
+
+# Set indentation
+Mui.set :tabstop, 2
+Mui.set :shiftwidth, 2
+Mui.set :expandtab, true
+```
+
+See [Configuration]({{ site.baseurl }}/configuration) for all options.
+
+## Next Steps
+
+- [Key Bindings]({{ site.baseurl }}/keybindings) - Complete key reference
+- [Configuration]({{ site.baseurl }}/configuration) - Customize Mui
+- [Plugins]({{ site.baseurl }}/plugins) - Extend functionality

data/docs/index.md

@@ -0,0 +1,55 @@
+---
+title: Home
+layout: home
+nav_order: 1
+---
+
+# Mui (無為)
+
+A Vim-like TUI text editor written in Ruby.
+{: .fs-6 .fw-300 }
+
+> **無為 (むい, mui)** - "Effortless action" from Taoist philosophy.
+> *"Form without forcing, existing as it is. Yet from nothing, something is born."*
+
+[Get Started]({{ site.baseurl }}/getting-started){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[View on GitHub](https://github.com/S-H-GAMELINKS/mui){: .btn .fs-5 .mb-4 .mb-md-0 .mr-2 }
+[RubyGems](https://rubygems.org/gems/mui){: .btn .btn-green .fs-5 .mb-4 .mb-md-0 }
+
+---
+
+## Installation
+
+```bash
+gem install mui
+```
+
+## Features
+
+- **Modal Editing** - Vim-like Normal, Insert, Visual, Command modes
+- **Syntax Highlighting** - Ruby, C, Go, Rust, JavaScript, TypeScript, Markdown, HTML, CSS
+- **Tab Pages & Window Splits** - Multiple files with flexible layouts
+- **Plugin System** - Extend functionality with Ruby gems
+- **LSP Support** - Language Server Protocol via mui-lsp plugin
+- **Japanese/UTF-8 Support** - Full multibyte character support
+
+## Quick Start
+
+```bash
+# Install from RubyGems
+gem install mui
+
+# Open a file
+mui myfile.rb
+
+# Or start with an empty buffer
+mui
+```
+
+## Official Plugins
+
+| Plugin | Description |
+|--------|-------------|
+| [mui-lsp](https://github.com/S-H-GAMELINKS/mui-lsp) | LSP (Language Server Protocol) support |
+| [mui-git](https://github.com/S-H-GAMELINKS/mui-git) | Git integration |
+| [mui-fzf](https://github.com/S-H-GAMELINKS/mui-fzf) | Fuzzy finder integration with fzf |