Peeka Project Website

This repository contains the GitHub Pages site for the Peeka project.

Structure

peeka-project.github.io/
├── _config.yml          # Jekyll configuration
├── index.md             # Landing page (Chinese)
├── installation.md      # Installation guide (Chinese)
├── quickstart.md        # Quick start guide (Chinese)
├── examples.md          # Usage examples (Chinese)
├── architecture.md      # Architecture documentation (Chinese)
├── troubleshooting.md   # Troubleshooting guide (Chinese)
├── commands/            # Command reference pages (Chinese)
│   ├── index.md         # Commands overview
│   ├── attach.md        # attach command
│   ├── watch.md         # watch command
│   ├── trace.md         # trace command
│   ├── stack.md         # stack command
│   ├── monitor.md       # monitor command
│   ├── logger.md        # logger command
│   ├── memory.md        # memory command
│   ├── inspect.md       # inspect command
│   ├── search.md        # search command (sc/sm)
│   └── reset.md         # reset command
└── en/                  # English version
    ├── index.md         # Landing page (English)
    └── commands/        # Command reference (English)
        └── index.md     # Commands overview

Languages

The site supports multilingual documentation:

• Chinese (中文): Root directory
• English: /en/
• Spanish (Español): /es/
• Japanese (日本語): /ja/

Users can switch languages using the language selector in the top navigation bar.

Theme

This site uses the Just the Docs theme, which provides:

• Clean, professional documentation layout
• Built-in search functionality
• Mobile-responsive design
• Easy navigation structure
• Code syntax highlighting

Local Development

Prerequisites

• Ruby 3.1+
• Bundler

Setup

cd peeka-project.github.io

# Install dependencies
bundle install

# Run local server
bundle exec jekyll serve --baseurl ""

# Open browser to http://localhost:4000/

Build

bundle exec jekyll build --baseurl ""
bundle exec jekyll build --config _config_en.yml --source en --destination _site/en --baseurl "/en"
bundle exec jekyll build --config _config_es.yml --source es --destination _site/es --baseurl "/es"
bundle exec jekyll build --config _config_ja.yml --source ja --destination _site/ja --baseurl "/ja"

The built site will be in _site/.

Deployment

The site is automatically deployed via GitHub Actions when changes are pushed to the main branch.

See .github/workflows/deploy-pages.yml for the deployment configuration.

GitHub Pages Settings

To enable GitHub Pages for this repository:

1. Go to repository Settings → Pages
2. Source: GitHub Actions
3. The site will be available at https://peeka-project.github.io/

Adding New Pages

1. Create a new .md file in the repository root or the relevant language directory
2. Add front matter:

   ---
   layout: default
   title: Your Page Title
   nav_order: 10
   ---

3. Write your content in Markdown
4. The page will automatically appear in the navigation

Adding New Command Documentation

1. Create a new .md file in commands/ or the relevant language commands/ directory
2. Add front matter:

   ---
   layout: default
   title: command-name
   parent: 命令参考
   nav_order: X
   ---

3. Document the command

Navigation Order

Pages are sorted by nav_order in the front matter:

• 1: 首页 (Home)
• 2: 安装指南 (Installation)
• 3: 快速开始 (Quick Start)
• 4: 命令参考 (Commands)
• 5: 示例教程 (Examples)
• 8: 架构设计 (Architecture)
• 9: 故障排除 (Troubleshooting)

Updating Documentation

When the project documentation changes:

1. Update the corresponding .md files in this repository
2. Commit and push to main
3. GitHub Actions will automatically rebuild and deploy the site

Customization

Colors

Edit _config.yml to change the color scheme:

color_scheme: light  # or dark, nil (system)

Logo

Add a logo by placing an image in assets/images/ and updating _config.yml:

logo: "https://peeka-project.github.io/assets/images/logo.png"

Footer

Edit the footer content in _config.yml:

footer_content: "Your custom footer text"

Resources

• Just the Docs Documentation
• Jekyll Documentation
• GitHub Pages Documentation