Obsidian CSV Table 插件使用教程

2 0 0

Obsidian CSV Table 插件使用教程

obsidian-csv-tableHave a CSV file you want to render some or all of the data from? This plugin allows you to display that data in your obsidian preview.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-csv-table

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

Obsidian CSV Table 插件的目录结构如下：


obsidian-csv-table/
├── github/
│   └── workflows/
├── src/
├── .gitignore
├── .bumpversion.cfg
├── LICENSE
├── README.md
├── jest.config.js
├── manifest.json
├── package.json
├── rollup.config.js
├── styles.css
├── tsconfig.json
└── versions.json

目录结构介绍

github/workflows/: 包含 GitHub Actions 的工作流配置文件。src/: 包含插件的源代码。.gitignore: 指定 Git 忽略的文件和目录。.bumpversion.cfg: 用于版本管理的配置文件。LICENSE: 项目的许可证文件。README.md: 项目的说明文档。jest.config.js: Jest 测试框架的配置文件。manifest.json: Obsidian 插件的清单文件，包含插件的元数据。package.json: 项目的 npm 配置文件，包含依赖和脚本。rollup.config.js: Rollup 打包工具的配置文件。styles.css: 插件的样式文件。tsconfig.json: TypeScript 的配置文件。versions.json: 版本信息文件。

2. 项目的启动文件介绍

Obsidian CSV Table 插件的启动文件主要是 src/ 目录下的源代码文件。具体启动逻辑通常在 main.ts 或 index.ts 文件中定义。

3. 项目的配置文件介绍

`manifest.json`

manifest.json 是 Obsidian 插件的清单文件，包含插件的元数据，如插件的 ID、名称、版本、作者等信息。


{
  "id": "obsidian-csv-table",
  "name": "CSV Table",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "Render CSV data as tables in Obsidian.",
  "author": "Adam Coddington",
  "authorUrl": "https://github.com/coddingtonbear",
  "isDesktopOnly": false
}

`package.json`

package.json 是 npm 配置文件，包含项目的依赖、脚本和其他元数据。


{
  "name": "obsidian-csv-table",
  "version": "1.0.0",
  "description": "Render CSV data as tables in Obsidian.",
  "main": "main.js",
  "scripts": {
    "build": "rollup -c rollup.config.js",
    "dev": "rollup -c rollup.config.js --watch",
    "test": "jest"
  },
  "author": "Adam Coddington",
  "license": "MIT",
  "dependencies": {
    "obsidian": "^0.12.0"
  },
  "devDependencies": {
    "jest": "^27.0.0",
    "rollup": "^2.0.0"
  }
}

`rollup.config.js`

rollup.config.js 是 Rollup 打包工具的配置文件，用于打包插件的源代码。


import typescript from '@rollup/plugin-typescript';
 
export default {
  input: 'src/main.ts',
  output: {
    file: 'main.js',
    format: 'cjs'
  },
  plugins: [
    typescript()
  ]
};

通过以上介绍，您可以更好地理解和使用 Obsidian CSV Table 插件。希望这份教程对您有所帮助！

# 随笔