GitHub Pages文档生成静态网站步骤

步骤分析:

1. 检查项目结构

2. 确认使用Jekyll生成GitHub Pages

3. 生成静态网站

执行步骤

1. 安装Ruby和Jekyll:

brew install ruby

gem install bundler jekyll

2. 在项目根目录创建或确认Gemfile:

source 'https://rubygems.org'

gem 'jekyll'

gem 'just-the-docs' # 基于当前文档格式使用的主题

3. 安装依赖:

bundle install

4. 在本地预览文档:

bundle exec jekyll serve

5. 访问本地站点: http://localhost:4000

6. 构建生产版本:

bundle exec jekyll build

生成的静态文件将位于 _site 目录。

要部署到GitHub Pages:

1. 在仓库设置中启用GitHub Pages

2. 选择 docs 目录作为源

3. 推送更改到main分支

访问: https://<username>.github.io/<repository>