Logseq 项目教程

Logseq 项目教程

logseq🦫 Soothing pastel theme for Logseq项目地址:https://gitcode.com/gh_mirrors/logs/logseq

项目的目录结构及介绍

Logseq 项目的目录结构如下：

logseq/
├── assets/
├── docs/
├── scripts/
├── src/
│   ├── main/
│   └── test/
├── .gitignore
├── .npmrc
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

• assets/: 存放项目所需的静态资源文件。
• docs/: 存放项目的文档文件。
• scripts/: 存放项目的脚本文件。
• src/: 存放项目的源代码文件。
  • main/: 存放主程序代码。
  • test/: 存放测试代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• .npmrc: 配置 npm 的设置。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目的许可证。
• README.md: 项目的介绍和使用说明。
• package.json: 项目的依赖和脚本配置。
• tsconfig.json: TypeScript 的配置文件。

项目的启动文件介绍

Logseq 项目的启动文件主要是 src/main/index.ts。这个文件是项目的入口点，负责初始化应用和启动主进程。

// src/main/index.ts
import { app, BrowserWindow } from 'electron';
import path from 'path';

function createWindow() {
  const mainWindow = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js'),
    },
  });

  mainWindow.loadFile('index.html');
}

app.whenReady().then(() => {
  createWindow();

  app.on('activate', function () {
    if (BrowserWindow.getAllWindows().length === 0) createWindow();
  });
});

app.on('window-all-closed', function () {
  if (process.platform !== 'darwin') app.quit();
});

项目的配置文件介绍

Logseq 项目的配置文件主要包括 package.json 和 tsconfig.json。

package.json

package.json 文件包含了项目的依赖、脚本和其他元数据。

{
  "name": "logseq",
  "version": "1.0.0",
  "description": "A privacy-first open-source platform for knowledge management and collaboration",
  "main": "src/main/index.ts",
  "scripts": {
    "start": "electron .",
    "build": "tsc",
    "test": "jest"
  },
  "dependencies": {
    "electron": "^13.1.7",
    "typescript": "^4.3.5"
  },
  "devDependencies": {
    "@types/jest": "^26.0.23",
    "jest": "^27.0.6",
    "ts-jest": "^27.0.3"
  }
}

tsconfig.json

tsconfig.json 文件是 TypeScript 的配置文件，用于指定编译选项。

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true
  },
  "include": ["src/**/*"]
}

以上是 Logseq 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用 Logseq 项目。

logseq🦫 Soothing pastel theme for Logseq项目地址:https://gitcode.com/gh_mirrors/logs/logseq