Skip to content

Add GitHub Action to publish docs to GitHub Pages on release #550

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
Copilot wants to merge 6 commits into
base: Maslow-Main
Choose a base branch
from
Draft

Add GitHub Action to publish docs to GitHub Pages on release #550

Copilot wants to merge 6 commits into from

Conversation

Copy link

Copilot AI commented Dec 3, 2025 •
edited
Loading

Automates publishing of markdown documentation from docs/ to GitHub Pages when releases are created, replacing manual website management with git-based content control.

Implementation

Workflow (.github/workflows/publish-docs.yml)

  • Triggers on release publication or manual dispatch
  • Converts markdown to HTML using [email protected] (pinned)
  • Deploys via official GitHub Pages actions

Conversion Script (.github/scripts/convert-docs.js)

  • Processes docs/ directory recursively
  • Converts README.md → index.html, preserves directory structure
  • Copies assets (jpg, png, gif, svg, pdf)
  • Generates responsive HTML with navigation headers
  • Handles relative paths correctly for both root and nested files

Landing Page

  • Creates index.html with cards linking to all documentation sections
  • Embedded styling for professional appearance

Documentation (.github/workflows/README-publish-docs.md)

  • Setup instructions: enable GitHub Pages with "GitHub Actions" source
  • Published URL: https://maslowcnc.github.io/Maslow_4/

Example Output

<!-- docs/assembling-the-arms-4-1/README.md becomes: -->
<html>
  <nav>← Documentation Home | GitHub | Forums</nav>
  <h1>Assembling the Arms 4.1</h1>
  <img src="images/arms-01.jpg" />
  <!-- styled, responsive content -->
</html>

CodeQL scan: 0 vulnerabilities

Original prompt

This section details on the original issue you should resolve

<issue_title>make script to publish from git to web page</issue_title>
<issue_description>in #525 web pages were converted to markdown, with images, in the repo.

Create an action to run when a release is made that will take the markdown pages in the repo and publish them to the web site.

The idea behind this is to convert the website from a stand-alone, manually managed site to have it's contents managed in git and published from here.</issue_description>

Comments on the Issue (you are @copilot in this section)

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Add action to publish markdown pages to website Add GitHub Action to publish docs to GitHub Pages on release Dec 3, 2025
Copilot AI requested a review from MaslowBot December 3, 2025 06:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MaslowBot MaslowBot Awaiting requested review from MaslowBot

Assignees

Copilot code review Copilot

@MaslowBot MaslowBot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

make script to publish from git to web page

2 participants

@MaslowBot