StickyLand 开源项目安装与使用指南

StickyLand 是一个旨在打破 Jupyter Notebooks 线性展示方式的开源项目，通过引入“粘性单元格”功能，允许用户自由拖拽创建和排列代码或Markdown单元格，构建非线性的交互式笔记本环境。

1. 项目目录结构及介绍

stickyland
├── github/workflows            # GitHub Actions 工作流配置文件
├── examples                     # 示例文件夹，包含应用示例
├── jupyterlab_stickyland        # JupyterLab 扩展的核心代码
├── src                          # 主要源代码存放位置
├── style                        # CSS样式文件
├── .eslintignore                # ESLint 忽略文件配置
├── .eslintrc.js                 # ESLint 配置文件
├── .gitattributes               # Git 属性文件
├── .gitignore                   # Git忽略文件列表
├── prettierignore               # Prettier 忽略文件配置
├── prettierrc                   # Prettier 格式化配置
├── yarnrc.yml                   # Yarn 配置文件
├── CHANGELOG.md                 # 版本更新日志
├── LICENSE                      # 许可证文件，采用BSD-3-Clause许可
├── MANIFEST.in                  # Python打包时所需文件清单
├── README.md                    # 项目介绍文档
├── RELEASE.md                   # 发布说明
├── install.json                 # 安装配置文件（可能用于JupyterLab插件管理）
├── package.json                 # NPM包配置文件
├── pyproject.toml               # Python项目配置
├── setup.py                     # Python安装脚本
├── tsconfig.json                # TypeScript编译配置
└── yarn.lock                    # Yarn依赖锁定文件

2. 项目的启动文件介绍

在 stickyland 项目中，并没有直接指定一个单一的“启动文件”，因为这个项目主要是作为JupyterLab的一个扩展开发。用户并不直接运行这个仓库中的任何脚本来启动项目。安装并使用StickyLand主要涉及的是对JupyterLab环境的配置和扩展安装过程，具体步骤如下：

1. 安装JupyterLab
2. 通过pip安装StickyLand: 使用命令 pip install stickyland。

若需从源码构建和开发，开发者需要执行以下命令来搭建开发环境并启动JupyterLab进行测试：

# 在项目根目录下
jlpm install     # 或者使用yarn安装依赖
jlpm run build   # 构建项目
pip install -e . # 安装开发版本
jupyter lab      # 启动JupyterLab

3. 项目的配置文件介绍

3.1 主要配置文件

• package.json 和 pyproject.toml：定义了项目的元数据，包括依赖项、构建指令等。

• .eslintrc.js, prettierrc: 这些是JavaScript和代码风格相关的配置文件，用于统一代码风格和进行静态代码分析。

• tsconfig.json: TypeScript编译器的配置文件，指导TypeScript如何编译到JavaScript。

对于实际的运行配置，StickyLand更多地依赖于用户的JupyterLab配置以及Python环境设置。JupyterLab本身可以通过.jupyter/labconfig下的配置文件进行自定义，但这些通常不是StickyLand直接提供的部分，而是用户依据个人需求调整的。

由于StickyLand专注于作为JupyterLab的扩展，其核心配置逻辑内嵌于代码之中，用户端并不直接编辑特定的StickyLand配置文件来控制行为，而是通过JupyterLab的UI界面或命令来管理和配置该扩展的功能。