Welcome to the Style Guide for tools and resources! This document provides best practices and recommendations to ensure consistency and quality across our projects.

Code Style

  • Naming Conventions: Use snake_case for variables and camelCase for functions.
    code_editor
  • Indentation: Always use 4 spaces for indentation.
  • Comments: Write clear and concise comments in English.

Documentation

  • Markdown Syntax: Follow standard Markdown formatting for readability.
    markdown_editor
  • Structure: Include sections like Introduction, Usage, and Examples.
  • Links: Reference internal resources using paths like /style-guide or /tools.

UI/UX Design

  • Consistency: Maintain uniformity in color schemes and typography.
    ui_design_tools
  • Accessibility: Ensure contrast ratios and keyboard navigation support.
  • Icons: Use standardized icons from our asset library.

Resources

Explore more guidelines by visiting /style-guide or check out our Tools Directory for additional resources!

terminal_window