geticon 项目使用教程

geticon 项目使用教程

geticonWeb / IT project stack / tool / technique icon / logo collection & markdown / HTML generator :electron:🚀项目地址:https://gitcode.com/gh_mirrors/ge/geticon

1. 项目的目录结构及介绍

geticon 项目的目录结构如下：

geticon/
├── icons/
├── scripts/
├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitattributes
├── .gitignore
├── .prettierignore
├── .prettierrc.js
├── LICENSE
├── README.md
├── icons.json
├── index.js
├── input.txt
├── package.json
├── settings.json
├── svgo.config.js
├── tsconfig.json
└── yarn.lock

目录介绍

• icons/: 存放项目图标的目录。
• scripts/: 存放项目脚本的目录。
• .editorconfig: 编辑器配置文件。
• .eslintignore: ESLint 忽略文件。
• .eslintrc.js: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件。
• .prettierignore: Prettier 忽略文件。
• .prettierrc.js: Prettier 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• icons.json: 图标配置文件。
• index.js: 项目入口文件。
• input.txt: 输入文件。
• package.json: 项目依赖配置文件。
• settings.json: 项目设置文件。
• svgo.config.js: SVGO 配置文件。
• tsconfig.json: TypeScript 配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js。这个文件是项目的入口点，负责初始化和启动项目。

3. 项目的配置文件介绍

配置文件列表

• .editorconfig: 编辑器配置文件，用于统一不同编辑器和 IDE 的代码风格。
• .eslintrc.js: ESLint 配置文件，用于代码检查和格式化。
• .prettierrc.js: Prettier 配置文件，用于代码格式化。
• package.json: 项目依赖配置文件，包含项目的依赖包和脚本命令。
• settings.json: 项目设置文件，包含项目的自定义设置。
• svgo.config.js: SVGO 配置文件，用于优化 SVG 图标。
• tsconfig.json: TypeScript 配置文件，用于 TypeScript 项目的编译设置。

配置文件详细介绍

.editorconfig

root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

.eslintrc.js

module.exports = {
  env: {
    browser: true,
    es2021: true,
  },
  extends: 'eslint:recommended',
  parserOptions: {
    ecmaVersion: 12,
    sourceType: 'module',
  },
  rules: {
  },
};

.prettierrc.js

module.exports = {
  semi: true,
  trailingComma: 'all',
  singleQuote: true,
  printWidth: 80,
  tabWidth: 2,
};

package.json

{
  "name": "geticon",
  "version": "1.0.0",
  "description": "Web / IT project stack / tool / technique icon / logo collection & markdown / HTML generator",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "git+https://github.com/get-icon/geticon.git"
  },
  "keywords": [
    "icon",
    "logo",
    "stack",
    "tool",
    "web",
    "markdown"
  ],
  "author": "get-icon

geticonWeb / IT project stack / tool / technique icon / logo collection & markdown / HTML generator :electron:🚀项目地址:https://gitcode.com/gh_mirrors/ge/geticon