[PR #545] [CLOSED] Initial setup and configure of Retype #1105

New Issue

claunia · 2026-01-29T14:49:45Z

claunia commented

2026-01-29 14:49:45 +00:00

📋 Pull Request Information

Original PR: https://github.com/xoofx/markdig/pull/545
Author: @geoffreymcgill
Created: 4/22/2021
Status: ❌ Closed

Base: master ← Head: master

📝 Commits (2)

cd9b9c9 Initial setup and configure of Retype
c663ae9 Configure /src folder generation of .md docs

📊 Changes

10 files changed (+118 additions, -18 deletions)

View changed files

📝 .github/workflows/ci.yml (+5 -2)
➕ .github/workflows/retype.yml (+25 -0)
📝 .gitignore (+3 -0)
➕ api/index.yml (+2 -0)
📝 changelog.md (+9 -6)
➕ img/markdig-logo-dark.svg (+6 -0)
➕ img/markdig-logo.svg (+6 -0)
📝 readme.md (+18 -10)
➕ retype.json (+42 -0)
➕ src/index.yml (+2 -0)

📄 Description

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.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/xoofx/markdig/pull/545 **Author:** [@geoffreymcgill](https://github.com/geoffreymcgill) **Created:** 4/22/2021 **Status:** ❌ Closed **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (2) - [`cd9b9c9`](https://github.com/xoofx/markdig/commit/cd9b9c98622eb9ddb8a283de0ee1eacf64036acb) Initial setup and configure of Retype - [`c663ae9`](https://github.com/xoofx/markdig/commit/c663ae932258dbb531162f4d3113e51406dcd0da) Configure /src folder generation of .md docs ### 📊 Changes **10 files changed** (+118 additions, -18 deletions) <details> <summary>View changed files</summary> 📝 `.github/workflows/ci.yml` (+5 -2) ➕ `.github/workflows/retype.yml` (+25 -0) 📝 `.gitignore` (+3 -0) ➕ `api/index.yml` (+2 -0) 📝 `changelog.md` (+9 -6) ➕ `img/markdig-logo-dark.svg` (+6 -0) ➕ `img/markdig-logo.svg` (+6 -0) 📝 `readme.md` (+18 -10) ➕ `retype.json` (+42 -0) ➕ `src/index.yml` (+2 -0) </details> ### 📄 Description 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

claunia added the pull-request label 2026-01-29 14:49:45 +00:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/markdig#1105