You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
documentationImprovements or additions to documentation
1 participant
Heading
Bold
Italic
Quote
Code
Link
Numbered list
Unordered list
Task list
Attach files
Mention
Reference
Menu
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Noll 是一个用 Go 编写的静态 HTML 和 CSS 网站生成器。它是专为 GitHub 平台而开发的。Noll 获取用户的 Discussions 和指定的模板,并将它们呈现为一个完整的 HTML 网站。
快速开始
创建站点 Repository
你首先需要一个用于部署网站的 Repository(仓库),这里推荐直接 Fork
NollAction
仓库并重命名。你也可以创建一个空仓库,并添加
NollAction
的noll.yml
workflow。这个 workflow 是一个用于自动编译,打包和发布网站到线上的 Action。这个仓库可以命名为:
noll.github.io
(noll
替换为你的github
用户名),也可以是其他名字,比如blog
等。如果你的仓库名是前者,那么你的网站最终地址是https://noll.github.io
,如果是后者,那么你的网站地址是https://noll.github.io/blog
。开启 GitHub Discussions
Noll 采用 GitHub Discussions 作为发布和保存文章的数据源,所以需要开启 Repository Discussions。
在 Repository 的设置页,下滑找到
Features
列表,找到Discussions
功能,勾选开启,如下:开启 GitHub Pages 并设置
Source
为Github Actions
在 Repository 的设置页的左边栏里,点击
Pages
菜单,进入GitHub Pages
页面。然后设置Build and deployment
的Source
为Github Actions
(workflow
里面用到了发布到GitHub Pages
的框架和自定义构建过程)。启用 Workflow
通过 Fork NollAction 创建的仓库的必要步骤,通过手动创建仓库的用户可跳过此步骤。
GitHub 对于 Forked 仓库的
Workflow
默认不启用,提示如下:由于此存储库在分叉时包含工作流文件,因此我们已禁止它们在此分叉上运行。在此存储库上启用操作之前,请确保您了解已配置的工作流及其预期用途。
所以需要你启用我们的
Workflow
。创建文章
接下来就可以创建文章了。
创建文章就是创建一个讨论(
Discussion
)的过程,比如我们要创建一个Hello world
的文章。首先进入你的 Repository Discussions 页面,点击右边的
New Discussion
按钮,选择一个Category
(分类),进入编辑页,输入Hello world
标题并随便写点什么,然后点击下方的Start discussion
按钮,即可发布文章了。发布新文章会触发 GitHub Action,然后执行我们的
workflow
——noll.yml
,然后noll.yml
会编译打包我们的网站,并最终会布网站到你的站点。浏览器里访问:https://nollgo.github.io/Noll/ (假如你的用户名是
NollGo
,仓库名是Noll
)可在 GitHub Action 的最近一次构建里看到具体地址,如下:
更新 Noll
为了获得更好的体验,我们建议你保持较新版本的 Noll,这不会花费你太多时间即可更新到最新的版本。
通过
Sync Fork
方式更新 Noll如果你的站点仓库是通过 Fork
NollAction
的方式创建的,那么请使用此方法。如果没有,则表示当前版本为最新版本,无需更新。
最后别忘了
Re-run all jobs
你的 Action。通过更新 workflow 的方式更新 Noll
如果你的站点仓库是手动创建的,那么请使用此方法。
手动创建的站点仓库,需要手动更新 workflow。
.github/workflows/noll.yml
文件,复制noll.yml
文件内容;.github/workflows/noll.yml
文件,粘贴刚刚复制的内容,完成更新。最后别忘了
Re-run all jobs
你的 Action。Beta Was this translation helpful? Give feedback.
All reactions