提交文章

范围#

我们发布高质量的博客文章,涵盖 Scientific Python 生态系统中的软件包。虽然我们专注于展示这些软件包的出色使用,但我们也对项目的非编码或技术方面感兴趣。

我们喜欢代码示例。虽然我们期望代码质量良好,但我们更关注故事而不是代码,并且比提交代码到主要库时要求的代码细节要少。不过,最佳实践需要遵守(无论是通用的 Python 结构、风格,还是使用库的最佳实践),审阅者会确保这一点。

我们不接受任何赞助或推广文章。提到您的组织是可以接受的,但不能成为文章的重点。

在最低限度上,提交的内容必须

  • 主题主要与 Scientific Python 生态系统中至少一个项目相关。
  • 作者有权在 BSD 3-Clause 许可证下发布代码,并在 Creative Common CC-BY-4.0 许可证下发布文本。
  • 尊重我们的行为准则.
  • 用英文书写。

提交文章#

任何人都欢迎提交博客文章,几乎不需要任何技术知识。

我们使用 GitHub 来管理文章提交。要创建提交,请在我们的 Git 仓库中打开一个拉取请求 (PR)

https://github.com/scientific-python/blog.scientific-python.org/pulls

如果您不熟悉 GitHub,请查看此处,了解有关如何创建 PR 的更多信息。

一些额外的注意事项。

  • 此项目使用 pre-commit 钩子。当您构建博客时,这些钩子会自动安装。
  • 不要在您的分支上进行变基或强制推送。只有在您需要获取最新版本时才将其合并到main中。这可以防止过去的审核与您的分支不同步。

创建文章#

该博客使用Hugo来创建和渲染博客。为了获得更好的体验,我们建议您在本地机器上安装它。这将允许您构建博客并查看您的文章将是什么样子。

注意:在创建 PR 时,您将能够看到包含您内容的博客的渲染版本。

键入以下命令以创建新文章,其中[library]是关联的项目之一(请查看现有内容以获取示例)

hugo new content/posts/[library]/[title]/index.md

此命令将在folder_repository/content/posts/[library]下创建一个新文件夹。这将是您的文章工作目录。如果您想将外部内容添加到您的文章(例如,图像),您将在该文件夹中添加它。

您现在可以使用您喜欢的文本编辑器打开您文章文件夹中的index.md文件。该文件包含一些基本内容以帮助您入门。

前言#

您将看到一个由 — 分隔的标题部分。让我们来看看您可以配置的所有标题

title: "Your fancy title"

这是您的文章标题,它将出现在页面开头。选择一个朗朗上口的标题。

date: 2019-09-01T21:37:03-04:00

当前日期和时间,您不需要修改它。

draft: true

指定文章是草稿还是已发布。

description: "This is my first post contribution."

这是对您文章主题的详细描述。根据您的内容进行修改。

tags: ["tutorials", [library]]

选择您要将文章添加到其中的类别。审阅者将对此提供帮助。

displayInList: true

指定您希望文章出现在最新文章列表中,以及指定类别的文章列表中。

author: ["Bob"]

添加您的姓名作为作者。多个作者用逗号分隔。

resources:
- name: featuredImage
  src: "my-image.png"
  params:
    description: "my image description"
    showOnTop: true

选择要与您的文章关联的图像,该图像将显示在主页标题旁边。确保将my-image.png添加到您的文章文件夹。参数showOnTop决定是否在您的文章顶部也显示图像。

写作!#

现在,您可以写下您的文章的正文。我们完全支持Markdown,因此使用它来格式化您的文章。

要预览您的新文章,请打开一个终端并键入

make serve

然后打开浏览器并访问http://localhost:1313,确保您的文章出现在主页中。如果您发现错误或想要调整的内容,请返回到您的index.md文件并进行修改。如果您正在编辑笔记本,则需要在更改生效之前运行make executed_notebooks

图像#

图像必须为 PNG 格式,并使用pngcrushpngquant之类的工具进行压缩。例如

pngquant --ext .png --force my_figure.png

另一个重要方面是替代文本。所有图形都必须包含替代文本。这对包容性非常重要。

在此页面上