[PR #545] Initial setup and configure of Retype #1110

Open
opened 2026-01-29 14:49:48 +00:00 by claunia · 0 comments
Owner

Original Pull Request: https://github.com/xoofx/markdig/pull/545

State: closed
Merged: No


Setup and configure Retype static site generator for Markdig.

Based on https://github.com/xoofx/markdig/issues/439#issuecomment-824489198.

This generated website can be hosted from GitHub Pages, although the repo owner would need to make one simple config to enable the GitHub Pages hosting. Details available at:
https://retype.com/guides/github_actions/#pick-a-branch

The website could also be hosted from a custom domain or subdomain. If that's the case, a couple of minor changes would need to be made to the retype.json. Based on the following docs:
https://retype.com/guides/github_actions/#custom-domain

The following two changes would be required in the retype.json if using custom domain or subdomain hosting with GitHub Pages:

Revised retype.json for custom domain or subdomain

{
  "input": ".",
  "output": ".retype",
  "base": "markdig",          <-- remove base
  "cname": "docs.example.com" <-- add cname
  ...
}

No worries if this is of no interest; feel free to close or delete the PR.

Hope this helps.

**Original Pull Request:** https://github.com/xoofx/markdig/pull/545 **State:** closed **Merged:** No --- Setup and configure [Retype](https://retype.com/) static site generator for Markdig. Based on https://github.com/xoofx/markdig/issues/439#issuecomment-824489198. This generated website can be hosted from GitHub Pages, although the repo owner would need to make one simple config to enable the GitHub Pages hosting. Details available at: https://retype.com/guides/github_actions/#pick-a-branch The website could also be hosted from a custom domain or subdomain. If that's the case, a couple of minor changes would need to be made to the `retype.json`. Based on the following docs: https://retype.com/guides/github_actions/#custom-domain The following two changes would be required in the `retype.json` if using custom domain or subdomain hosting with GitHub Pages: #### Revised retype.json for custom domain or subdomain ``` { "input": ".", "output": ".retype", "base": "markdig", <-- remove base "cname": "docs.example.com" <-- add cname ... } ``` No worries if this is of no interest; feel free to close or delete the PR. Hope this helps.
claunia added the pull-request label 2026-01-29 14:49:49 +00:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/markdig#1110