GitHub Pages
要从 JS.ORG 为你的 GitHub Pages 站点获取一个简短且时尚的子域名,请遵循以下 4 个步骤:
步骤 1
如果你还没有,请登录你的 GitHub 账户,并按照他们的说明设置你的 GitHub Pages 站点。请确保为你的新页面添加一些合理的内容。
步骤 2
现在确定你的 JS.ORG 子域名:根据现有的 GitHub Pages URL,选择你的用户名或你的仓库名称(对于 http://foo.github.io/bar,foo.js.org 或 bar.js.org 都是可能的)。我们在 wiki 中有关于选择合适子域名的更多指导:https://github.com/js-org/js.org/wiki/Subdomain-Determination。
步骤 3
如果你正在从分支发布:
在你的仓库中添加一个名为 CNAME 的文件(对于项目页面,在 gh-pages 分支中,或者在你设置为 GitHub Pages 源的分支中),其中包含一行与你选择的域名匹配的内容(例如 foo.js.org)。如果需要,你也可以使用下面讨论的仓库设置中的 UI。
如果你正在使用工作流发布:
通过工作流发布站点时,CNAME 文件不会被处理,因此你需要使用仓库设置中的 UI 来添加自定义域名。进入仓库设置,在 Pages 选项卡下,将你的 JS.ORG 子域名添加为自定义域名。
步骤 4
要完成此流程,请在此 GitHub 仓库中创建一个 pull request,将您的子域名添加到现有 JS.ORG 域名的 subdomains list 中。您的新 URL 应在 24 小时内生效(请密切关注您的 pull request,以防出现命名冲突或需要修改)。
Other Providers
如果您希望将 JS.ORG 用于托管在其他地方的网站,也可以这样做!
Step 1
如果您尚未完成,请使用您选择的任何托管提供商设置您的网站。请注意,要使用 JS.ORG,您的托管提供商必须支持通过 CNAME DNS 记录添加自定义域名。
Step 2
现在确定您的 JS.ORG 子域名:根据现有的 GitHub Pages URL,选择您的用户名或您的仓库名称(对于 http://foo.github.io/bar,foo.js.org 或 bar.js.org 都是可能的)。我们在 wiki 中提供了更多关于选择合适子域名的指导:https://github.com/js-org/js.org/wiki/Subdomain-Determination。
Step 3
如果需要配置,请按照您的托管提供商的说明将自定义域名添加到您的网站。我们的 wiki 包含一份我们过去看到人们成功使用的托管提供商列表,包括一些关于正确配置其中一些提供商的说明:https://github.com/js-org/js.org/wiki/3rd-party-hosts。
Step 4
与将子域名添加到 GitHub Pages 站点一样,最后一步是在此 GitHub 仓库中创建一个 pull request,将您的子域名添加到现有 JS.ORG 域名的 subdomains list 中。
内容要求
[!IMPORTANT] 请注意,托管在 JS.ORG 子域名上的网站内容需遵守以下规则:
网站必须与 JavaScript 生态系统/社区直接相关(例如 NPM 包 / JS 工具,而非个人页面 / 作品集)
- 禁止占位页面。网站必须包含与其目的相关的实质性内容。
- 禁止自动重定向离开 js.org 域名。重定向必须需要用户交互。
- 禁止无关内容。网站必须专注于其预期主题或目的。
_此外,请注意我们关于 JS.ORG 服务的完整条款和条件。
感谢 Cloudflare 提供出色的 DNS 服务,使本服务成为可能。尽管 JS.ORG 在某种程度上无节制地使用了他们的免费套餐,但他们多次通过灵活的解决方案和扩展配额为我们提供了帮助。非常感谢!