Pelican-Jupyter 项目使用教程

Pelican-Jupyter 项目使用教程

pelican-jupyterPelican plugin for blogging with Jupyter/IPython Notebooks项目地址:https://gitcode.com/gh_mirrors/pe/pelican-jupyter

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

Pelican-Jupyter 项目的目录结构如下：

pelican-jupyter/
├── LICENSE
├── README.md
├── pelicanconf.py
├── requirements.txt
├── setup.py
└── pelican_jupyter/
    ├── __init__.py
    ├── ipynb.py
    ├── liquid.py
    └── tests/
        ├── __init__.py
        ├── test_ipynb.py
        └── test_liquid.py

目录结构介绍

• LICENSE: 项目的许可证文件。
• README.md: 项目的基本介绍和使用说明。
• pelicanconf.py: Pelican 的配置文件。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目的安装脚本。
• pelican_jupyter/: 项目的主要代码目录。
  • __init__.py: 模块初始化文件。
  • ipynb.py: 处理 Jupyter Notebook 文件的模块。
  • liquid.py: 处理 Liquid 标签的模块。
  • tests/: 测试代码目录。
    • __init__.py: 测试模块初始化文件。
    • test_ipynb.py: 针对 ipynb.py 的测试代码。
    • test_liquid.py: 针对 liquid.py 的测试代码。

2. 项目的启动文件介绍

项目的启动文件主要是 pelicanconf.py，它是 Pelican 的配置文件。在这个文件中，你可以配置 Pelican 的各种参数，包括插件的启用和配置。

pelicanconf.py 示例

#!/usr/bin/env python
# -*- coding: utf-8 -*-

from __future__ import unicode_literals

AUTHOR = 'Your Name'
SITENAME = 'Your Site Name'
SITEURL = 'http://localhost:8000'

PATH = 'content'

TIMEZONE = 'Asia/Shanghai'

DEFAULT_LANG = 'zh'

# 启用 pelican-jupyter 插件
PLUGINS = [
    'pelican_jupyter'
]

# 其他配置...

3. 项目的配置文件介绍

项目的配置文件主要是 pelicanconf.py，它包含了 Pelican 的各种配置选项。以下是一些常用的配置选项：

常用配置选项

• AUTHOR: 网站的作者名称。
• SITENAME: 网站的名称。
• SITEURL: 网站的 URL。
• PATH: 内容文件的存放路径。
• TIMEZONE: 时区设置。
• DEFAULT_LANG: 默认语言。
• PLUGINS: 启用的插件列表，这里需要包含 pelican_jupyter。

插件配置

在 pelicanconf.py 中，你可以配置 pelican_jupyter 插件的参数。例如：

# 启用 pelican-jupyter 插件
PLUGINS = [
    'pelican_jupyter'
]

# 配置 pelican-jupyter 插件
JUPYTER_SETTINGS = {
    'default_cell_type': 'markdown',
    'include_source': True,
    'include_outputs': True,
    'include_images': True,
}

通过这些配置，你可以控制 Jupyter Notebook 文件在 Pelican 中的渲染方式。

---

以上是 Pelican-Jupyter 项目的基本使用教程，希望对你有所帮助。

pelican-jupyterPelican plugin for blogging with Jupyter/IPython Notebooks项目地址:https://gitcode.com/gh_mirrors/pe/pelican-jupyter