midasvo/the-list

the-list

该项目灵感来源于/r/soccer社区的一条评论，随后衍生出/r/SaddestBackflip子版块，现为方便用户查找不同版本的列表而转化为网站。同时还在开发相关机器人，详见：https://github.com/midasvo/the-list-bot

核心功能

• 分页功能：主页配备分页组件，避免一次性展示所有内容。
• JSON API：支持通过GET请求轻松获取内容（例如，在URL后追加'/items/index.json'，如[***]

贡献指南

以下是关于开发网站、外部应用、创建帖子及提出想法的贡献方式。

添加内容到列表

若想添加内容到列表，可选择以下两种方式：

1. 搭建开发环境，创建帖子并提交拉取请求（PR）。
2. 在https://github.com/midasvo/the-list/issues%E5%88%9B%E5%BB%BA%E9%97%AE%E9%A2%98%EF%BC%8C%E5%BC%80%E5%8F%91%E8%80%85%E4%BC%9A%E5%8D%8F%E5%8A%A9%E5%AE%8C%E6%88%90%E3%80%82

开发步骤

环境要求

• Git
• Homebrew
• Hugo（静态网站生成器）

安装Homebrew

适用于mac和linux系统：Homebrew官网
Windows系统：可从https://github.com/gohugoio/hugo/releases%E4%B8%8B%E8%BD%BD%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E3%80%82

安装Hugo

bash
brew install hugo

克隆仓库

bash
git clone https://github.com/midasvo/the-list.git

运行网站

bash
cd the-list
hugo server

创建新帖子

执行以下命令在'the-list/content/items/'目录下生成新的Markdown文件，该文件代表一篇帖子。运行'hugo server'后，帖子会在UI中显示：

bash
hugo new items/it-was-the-saddest-backflip.md

文件初始内容如下：

yaml
---
title: "It Was the Saddest Backflip"
date: 2020-11-24T19:17:30+01:00
itemurl: ""
itemurl_archive: ""
itemurl_soccer: ""
itemurl_saddestbackflip: ""
tags: []
draft: false
---

修改标题、日期，并添加可用的itemurl链接：

• itemurl：文章链接
• itemurl_archive：原始链接失效时的存档链接
• itemurl_soccer：/r/soccer线程链接
• itemurl_saddestbackflip：/r/saddestbackflip线程链接

创建拉取请求

TODO