lighterhtml 项目教程

lighterhtml 项目教程

lighterhtmlThe hyperHTML strength & experience without its complexity 🎉项目地址:https://gitcode.com/gh_mirrors/li/lighterhtml

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

lighterhtml 项目的目录结构如下：

lighterhtml/
├── .github/
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── README.md
├── es.config.js
├── es.js
├── index.d.ts
├── index.js
├── min.js
├── package.json
├── rollup.config.js
└── test/

目录结构介绍

• .github/: GitHub 相关文件，如 issue 模板等。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmignore: 指定 npm 发布时忽略的文件和目录。
• .travis.yml: Travis CI 配置文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• es.config.js: ES 配置文件。
• es.js: ES 模块文件。
• index.d.ts: TypeScript 类型定义文件。
• index.js: 项目入口文件。
• min.js: 压缩后的 JavaScript 文件。
• package.json: 项目元数据和依赖管理文件。
• rollup.config.js: Rollup 打包配置文件。
• test/: 测试文件目录。

2. 项目的启动文件介绍

项目的启动文件是 index.js，它是 lighterhtml 的主要入口点。该文件导出了主要的 API 函数，包括 html 和 svg 标签函数，用于创建 HTML 和 SVG 内容。

启动文件内容概览

// index.js
export { render, html, svg } from './es.js';

主要功能

• render: 用于渲染 HTML 和 SVG 内容。
• html: 用于创建 HTML 内容。
• svg: 用于创建 SVG 内容。

3. 项目的配置文件介绍

package.json

package.json 文件包含了项目的元数据和依赖信息。以下是一些关键字段：

{
  "name": "lighterhtml",
  "version": "4.0.0",
  "description": "The hyperHTML strength & experience without its complexity",
  "main": "index.js",
  "module": "es.js",
  "types": "index.d.ts",
  "scripts": {
    "test": "npm run build && node test/index.js",
    "build": "rollup -c"
  },
  "keywords": [
    "hyperhtml",
    "lighterhtml",
    "web",
    "components",
    "custom",
    "elements"
  ],
  "author": "Andrea Giammarchi",
  "license": "ISC",
  "devDependencies": {
    "rollup": "^2.3.4",
    "rollup-plugin-terser": "^5.3.0"
  }
}

关键字段介绍

• name: 项目名称。
• version: 项目版本。
• description: 项目描述。
• main: 主入口文件。
• module: ES 模块入口文件。
• types: TypeScript 类型定义文件。
• scripts: 脚本命令，如测试和构建命令。
• keywords: 项目关键词。
• author: 项目作者。
• license: 项目许可证。
• devDependencies: 开发依赖。

rollup.config.js

rollup.config.js 文件是 Rollup 的配置文件，用于打包项目。

// rollup.config.js
import { terser } from 'rollup-plugin-terser';

export default {
  input: 'es.js',
  output: [
    { file: 'index.js', format: 'cjs' },
    { file: 'es.js', format: 'es' },
    { file: 'min.js', format: 'iife', name: 'lighterhtml', plugins: [terser()] }
  ]
};

关键配置介绍

• input: 输入文件。
• output: 输出配置，包括 CommonJS、ES 模块

lighterhtmlThe hyperHTML strength & experience without its complexity 🎉项目地址:https://gitcode.com/gh_mirrors/li/lighterhtml