我最近一直在学习如何使用Docusaurus制作降价文档网站。我的确切问题是:
- 如何命名存储库
- 在这个配置中我需要更改什么:https://i.stack.imgur.com/4WAhY.png
- 我需要什么分支
我的目标是在ruixe.github.io创建一个网站,而不是在ruixey.github.io/REPO_NAME/
提前感谢的任何帮助
Docusaurus侧
根据Docusaurus提供的文档,我所能看到的一切看起来都是正确的:
部署到GitHub Pages|Docusauru。
它说明了以下关于使用哪个分支的信息:
GitHub Pages从默认分支(master/main(或gh Pages分支提取文件。。。
并用于部署到GH页面:
我们提供
docusaurus deploy
命令
GitHub页面侧
关于您的存储库名称,我建议您阅读GitHub在Pages上提供的文档,其中介绍了在设置自封的GitHub Pages部署时的命名约定:创建GitHub页面站点
这些文档介绍了以下关于选择存储库名称的内容:
如果要创建用户站点,则存储库必须命名为
<user>.github.io
如果您的用户名包含大写字母,则必须小写这些字母。
来源:为您的网站创建存储库
您是否尝试使用当前的配置文件进行部署?我看不出它为什么会失败。
在这个配置中我需要更改什么
假设您的repo URI类似于:git@github.com:Ruixey/roblox.git
organizationName: 'Ruixey', // Usually your GitHub org/user name.
projectName: 'roblox', // Usually your repo name.
// git@github.com:Ruixey/roblox.git <-- your ssh URI
// ^ ^
// organizationName projectName
我需要什么分支?
main
对于您的源代码,当您部署时,docusaurus
将推送到gh-pages
分支,如果该分支不存在,则会创建它。
$ USE_SSH=true yarn deploy