GriddyCode 开源项目使用教程

GriddyCode 开源项目使用教程

griddycode项目地址:https://gitcode.com/gh_mirrors/gr/griddycode

项目的目录结构及介绍

GriddyCode 项目的目录结构如下：

griddycode/
├── AppData/
│   ├── langs/
│   │   └── ... (各种 Lua 文件)
│   ├── themes/
│   │   └── ... (各种 Lua 文件)
│   └── ... (其他配置文件)
├── cli/
│   └── gcode (CLI 支持)
├── docs/
│   └── ... (文档文件)
├── src/
│   └── ... (源代码文件)
├── .gitignore
├── README.md
└── ... (其他项目文件)

目录介绍

• AppData/: 包含项目的配置文件和扩展脚本。
  • langs/: 包含用于语法高亮和自动补全的 Lua 文件。
  • themes/: 包含用于改变 GriddyCode 外观的 Lua 文件。
• cli/: 包含命令行接口文件。
• docs/: 包含项目文档文件。
• src/: 包含项目的源代码文件。
• .gitignore: Git 忽略文件。
• README.md: 项目说明文件。

项目的启动文件介绍

GriddyCode 的启动文件是 gcode，位于 cli/ 目录下。该文件用于通过命令行启动 GriddyCode。

启动文件介绍

• gcode: 命令行接口文件，用于启动 GriddyCode。

使用方法：

gcode [文件或目录路径]

注意：需要将 gcode 文件添加到系统的 PATH 环境变量中。

项目的配置文件介绍

GriddyCode 的配置文件主要位于 AppData/ 目录下。

配置文件介绍

• langs/: 包含用于语法高亮和自动补全的 Lua 文件。
  • 例如：toml.lua 用于 TOML 文件的语法高亮。
• themes/: 包含用于改变 GriddyCode 外观的 Lua 文件。
  • 例如：dracula.lua 用于 Dracula 主题的配置。

配置文件示例

语法高亮配置

highlight("const", "reserved")

主题配置

-- 在 themes 目录下创建一个新主题文件，例如 dracula.lua
-- 内容示例：
local theme = {
    background = "#282a36",
    foreground = "#f8f8f2",
    -- 其他颜色配置
}
return theme

通过以上配置文件，可以自定义 GriddyCode 的语法高亮和主题样式。

griddycode项目地址:https://gitcode.com/gh_mirrors/gr/griddycode