frago-view-content-generate-tips-code
Code file content generation guide. Use this skill when you need to create code files that can be previewed via `frago view`. Covers supported languages, theme selection, and best practices.
When & Why to Use This Skill
This Claude skill serves as a comprehensive guide for generating code files optimized for the `frago view` previewer. It streamlines the development workflow by providing precise instructions on syntax highlighting for over 25 programming languages, theme customization, and essential coding standards. By following these best practices, developers can ensure their code is perfectly formatted, encoded, and visually optimized for terminal-based or web-based previews, enhancing both readability and collaboration.
Use Cases
- 1. Code Presentation & Review: Generating high-quality code snippets with specific themes like Monokai or GitHub Dark to improve visual clarity during peer reviews or demonstrations.
- 2. Cross-Platform Compatibility: Ensuring all generated code files adhere to UTF-8 encoding and LF line endings to prevent 'garbled text' and formatting issues across different operating systems.
- 3. Documentation Standardization: Using the guide to maintain consistent code structures, comment styles, and line lengths (under 120 characters) for better maintainability.
- 4. Multi-Language Configuration: Quickly identifying the correct highlight.js tags for diverse file types, including Rust, Go, TSX, and YAML, to ensure accurate syntax highlighting in preview tools.
| name | frago-view-content-generate-tips-code |
|---|---|
| description | Code file content generation guide. Use this skill when you need to create code files that can be previewed via `frago view`. Covers supported languages, theme selection, and best practices. |
Code File Content Generation Guide
Preview code files via frago view with automatic syntax highlighting.
Preview Commands
frago view script.py # Default theme
frago view script.py --theme monokai # Specify theme
Supported File Types
| Extension | Language | highlight.js Tag |
|---|---|---|
.py |
Python | python |
.js |
JavaScript | javascript |
.ts |
TypeScript | typescript |
.jsx |
JSX | javascript |
.tsx |
TSX | typescript |
.css |
CSS | css |
.scss |
SCSS | scss |
.html |
HTML | html |
.json |
JSON | json |
.yaml / .yml |
YAML | yaml |
.toml |
TOML | toml |
.xml |
XML | xml |
.sql |
SQL | sql |
.sh / .bash |
Bash | bash |
.go |
Go | go |
.rs |
Rust | rust |
.java |
Java | java |
.c / .h |
C | c |
.cpp / .hpp |
C++ | cpp |
.rb |
Ruby | ruby |
.php |
PHP | php |
.swift |
Swift | swift |
.kt |
Kotlin | kotlin |
.lua |
Lua | lua |
.r |
R | r |
.txt |
Plain Text | plaintext |
Code Themes
| Theme | Style | Use Case |
|---|---|---|
github-dark |
GitHub Dark (default) | Daily use |
github |
GitHub Light | White background preference |
monokai |
Monokai Classic | Developer preference |
atom-one-dark |
Atom Dark | Modern style |
atom-one-light |
Atom Light | Light preference |
vs2015 |
Visual Studio | Windows style |
# Preview with different themes
frago view main.py --theme monokai
frago view config.yaml --theme atom-one-dark
Best Practices
1. File Encoding
- Must use UTF-8 encoding
- Avoid BOM header
- Use LF line endings (Unix style)
2. Line Length
- Single line no more than 120 characters
- Very long lines will be truncated on display
3. Comment Guidelines
# Single-line comments should be clear and concise
"""
Multi-line comments used for:
- Module documentation
- Function documentation
- Complex logic explanation
"""
4. Code Structure
- Group logic with blank line separation
- Two blank lines between functions/classes
- Group related imports
Display Features
Automatic Line Numbers
Code preview automatically displays line numbers for easy reference.
Syntax Highlighting
Based on highlight.js, automatically recognizes language and highlights:
- Keywords
- Strings
- Comments
- Numbers
- Function names
- Class names
Style Reference (github-dark)
| Element | Color |
|---|---|
| Background | #0d1117 |
| Text | #c9d1d9 |
| Keywords | #ff7b72 |
| Strings | #a5d6ff |
| Comments | #8b949e |
| Functions | #d2a8ff |
| Numbers | #79c0ff |
Notes
| Issue | Cause | Solution |
|---|---|---|
| No syntax highlighting | Extension not recognized | Use standard extensions |
| Chinese garbled text | Encoding issue | Ensure UTF-8 |
| Truncated display | Line too long | Control line length |
| Slow rendering | File too large | Split or simplify |
Use Cases
- Code snippet display
- Configuration file preview
- Script review
- Code sharing
Not suitable for: Complete source code of large projects (recommend using IDE)