Gumshoe 开源项目教程

Gumshoe 开源项目教程

gumshoeA simple vanilla JS scrollspy script.项目地址:https://gitcode.com/gh_mirrors/gu/gumshoe

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

Gumshoe 项目的目录结构如下：

gumshoe/
├── dist/
│   ├── gumshoe.js
│   ├── gumshoe.min.js
│   └── gumshoe.polyfills.js
├── src/
│   ├── gumshoe.js
│   └── gumshoe.polyfills.js
├── test/
│   └── index.html
├── .babelrc
├── .editorconfig
├── .eslintrc
├── .gitignore
├── .npmignore
├── .travis.yml
├── LICENSE
├── package.json
├── README.md
└── webpack.config.js

目录介绍

• dist/：包含编译后的文件，可以直接在项目中使用。
  • gumshoe.js：未压缩的完整版本。
  • gumshoe.min.js：压缩后的版本。
  • gumshoe.polyfills.js：包含必要的 polyfills。
• src/：源代码目录。
  • gumshoe.js：主要源代码文件。
  • gumshoe.polyfills.js：源代码中的 polyfills。
• test/：测试文件目录。
  • index.html：测试页面。
• .babelrc：Babel 配置文件。
• .editorconfig：编辑器配置文件。
• .eslintrc：ESLint 配置文件。
• .gitignore：Git 忽略文件配置。
• .npmignore：NPM 忽略文件配置。
• .travis.yml：Travis CI 配置文件。
• LICENSE：项目许可证。
• package.json：NPM 包配置文件。
• README.md：项目说明文档。
• webpack.config.js：Webpack 配置文件。

2. 项目的启动文件介绍

Gumshoe 项目的启动文件是 dist/gumshoe.js 或 dist/gumshoe.min.js。这两个文件是编译后的版本，可以直接在项目中使用。

使用方法

在 HTML 文件中引入 gumshoe.js 或 gumshoe.min.js：

<script src="path/to/gumshoe.js"></script>

然后初始化 Gumshoe：

document.addEventListener('DOMContentLoaded', function () {
  var spy = new Gumshoe('#main-nav a', {
    // 配置选项
  });
});

3. 项目的配置文件介绍

Gumshoe 项目的配置文件主要是 package.json 和 webpack.config.js。

package.json

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

{
  "name": "gumshoe",
  "version": "5.1.3",
  "description": "A simple, framework-agnostic scrollspy script.",
  "main": "dist/gumshoe.js",
  "scripts": {
    "build": "webpack",
    "watch": "webpack --watch",
    "test": "http-server -o /test"
  },
  "dependencies": {},
  "devDependencies": {
    "babel-core": "^6.26.3",
    "babel-loader": "^7.1.5",
    "babel-preset-env": "^1.7.0",
    "eslint": "^4.19.1",
    "webpack": "^4.16.5",
    "webpack-cli": "^3.1.0"
  }
}

webpack.config.js

webpack.config.js 文件包含了 Webpack 的配置信息，用于构建和打包项目。

const path = require('path');

module.exports = {
  entry: './src/gumshoe.js',
  output: {
    filename: 'gumshoe.js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/,
        use: {
          loader: 'babel-loader'

gumshoeA simple vanilla JS scrollspy script.项目地址:https://gitcode.com/gh_mirrors/gu/gumshoe