2025-05-06 02:44:02 +00:00
<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "UTF-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< title > go-i2p/go-gh-page< / title >
2025-05-06 05:22:24 +00:00
< link rel = "stylesheet" href = "style.css" >
2025-05-06 02:44:02 +00:00
< / head >
< body >
< nav class = "nav-sidebar" >
< div class = "repo-info" >
< h2 >
< a href = "index.html" > go-i2p/go-gh-page< / a >
< / h2 >
< div class = "repo-meta" >
2025-05-06 21:38:12 +00:00
📝 23 commits
2025-05-06 02:44:02 +00:00
• 📜 MIT License
< / div >
< / div >
< ul class = "nav-links" >
< li > < a href = "index.html" class = "active" > Repository Overview< / a > < / li >
< / ul >
< div class = "nav-footer" >
< a href = "https://github.com/go-i2p/go-gh-page" target = "_blank" > View on GitHub< / a >
< / div >
< / nav >
< div class = "main-content" >
< header class = "repo-header" >
< h1 > go-i2p/go-gh-page< / h1 >
< div class = "repo-description" > A tool that automatically generates GitHub Pages static websites from repository content. It converts your repository's Markdown files to HTML with...< / div >
< div class = "repo-stats" >
< div class = "repo-stat" >
2025-05-06 21:38:12 +00:00
< span > 📝< / span > < span > 23 commits< / span >
2025-05-06 02:44:02 +00:00
< / div >
< div class = "repo-stat" >
2025-05-06 03:38:47 +00:00
< span > 📅< / span > < span > Last updated: May 6, 2025< / span >
2025-05-06 02:44:02 +00:00
< / div >
< div class = "repo-stat" >
< span > 📜< / span > < span > MIT License< / span >
< / div >
< / div >
< / header >
< main >
< section id = "readme" class = "repo-section" >
< h2 > README< / h2 >
< div class = "readme-content" >
< h1 id = "go-gh-page" > go-gh-page< / h1 >
2025-05-06 04:05:38 +00:00
< p > A tool that automatically generates GitHub Pages static websites from repository content. It converts your repository’ s Markdown files to HTML with a consistent layout, handles navigation, and preserves your documentation structure. It can be used as a github workflow for any repo.< / p >
2025-05-06 02:44:02 +00:00
< h2 id = "features" > Features< / h2 >
< ul >
< li > Generates a complete static website from your repository’ s content< / li >
< li > Converts Markdown files to HTML with proper rendering< / li >
< li > Creates navigation structure based on your documentation< / li >
< li > Displays repository information (commits, contributors, license)< / li >
< li > Preserves images and handles relative links< / li >
< li > Supports custom templates and styles< / li >
< li > Includes GitHub Actions workflow for automatic deployment< / li >
< / ul >
< h2 id = "installation" > Installation< / h2 >
< pre > < code class = "language-bash" > go install github.com/go-i2p/go-gh-page/cmd/github-site-gen@latest
< / code > < / pre >
< h2 id = "usage" > Usage< / h2 >
< h3 id = "basic-usage" > Basic Usage< / h3 >
< p > Generate a site for a GitHub repository:< / p >
< pre > < code class = "language-bash" > github-site-gen -repo owner/repo-name -output ./site
< / code > < / pre >
< h3 id = "command-line-options" > Command Line Options< / h3 >
< table >
< thead >
< tr >
< th > Flag< / th >
< th > Description< / th >
< th > Default< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td > < code > -repo< / code > < / td >
< td > GitHub repository in format ‘ owner/repo-name’ < / td >
< td > (Required)< / td >
< / tr >
< tr >
< td > < code > -output< / code > < / td >
< td > Output directory for generated site< / td >
< td > < code > ./output< / code > < / td >
< / tr >
< tr >
< td > < code > -branch< / code > < / td >
< td > Branch to use< / td >
< td > < code > main< / code > < / td >
< / tr >
< tr >
< td > < code > -workdir< / code > < / td >
< td > Working directory for cloning< / td >
< td > (Temporary directory)< / td >
< / tr >
< tr >
< td > < code > -githost< / code > < / td >
< td > Git host to use< / td >
< td > < code > github.com< / code > < / td >
< / tr >
< tr >
< td > < code > -main-template< / code > < / td >
< td > Path to custom main template< / td >
< td > (Built-in template)< / td >
< / tr >
< tr >
< td > < code > -doc-template< / code > < / td >
< td > Path to custom documentation template< / td >
< td > (Built-in template)< / td >
< / tr >
< tr >
< td > < code > -style-template< / code > < / td >
< td > Path to custom style template< / td >
< td > (Built-in template)< / td >
< / tr >
< / tbody >
< / table >
< h3 id = "using-with-github-actions" > Using with GitHub Actions< / h3 >
< p > The repository includes a GitHub Actions workflow file that can automatically generate and deploy your documentation to GitHub Pages.< / p >
< ol >
< li > Copy the < code > .github/workflows/page.yml< / code > file to your repository< / li >
< li > Enable GitHub Pages on your repository (Settings → Pages → Source: gh-pages branch)< / li >
< li > Customize the workflow as needed< / li >
< / ol >
< p > The workflow runs hourly by default and on pushes to the main branch, automatically updating your GitHub Pages.< / p >
< h2 id = "custom-templates" > Custom Templates< / h2 >
< p > You can provide custom templates for different components of the generated site:< / p >
< pre > < code class = "language-bash" > github-site-gen -repo owner/repo-name -output ./site \
-main-template path/to/main.html \
-doc-template path/to/doc.html \
-style-template path/to/style.css
< / code > < / pre >
< h2 id = "license" > License< / h2 >
< p > MIT License< / p >
< / div >
< / section >
< section id = "contributors" class = "repo-section" >
< h2 > Top Contributors< / h2 >
< div class = "contributors-list" >
< div class = "contributor-item" >
<!-- Use first letter as avatar if no image available -->
< div class = "contributor-avatar" >
2025-05-06 21:38:12 +00:00
e
2025-05-06 02:44:02 +00:00
< / div >
< div class = "contributor-info" >
< div class = "contributor-name" >
2025-05-06 21:38:12 +00:00
eyedeekay
2025-05-06 02:44:02 +00:00
< / div >
< div class = "contributor-commits" >
2025-05-06 21:38:12 +00:00
23 commits
2025-05-06 02:44:02 +00:00
< / div >
< / div >
< / div >
< / div >
< a href = "https://github.com/go-i2p/go-gh-page/graphs/contributors" target = "_blank" > View all contributors on GitHub →< / a >
< / section >
< / main >
< footer class = "page-footer" >
2025-06-08 14:18:49 +00:00
< p > Generated on 2025-06-08 14:18:48 • < a href = "https://github.com/go-i2p/go-gh-page" target = "_blank" > View on GitHub< / a > < / p >
2025-05-06 02:44:02 +00:00
< / footer >
< / div >
< / body >
< / html >
