Add support for page.md

Author: bcomnes

.claude/settings.local.json

@@ -0,0 +1,7 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(node --test:*)"
+    ]
+  }
+}

lib/build-pages/page-builders/md/get-md.js

@@ -114,11 +114,11 @@ function rewriteLinks (body /*, pretty */) {
   return body.replace(regex, function (_match, p1, p2, _p3) {
     const f = p2.toLowerCase()
 
-    // root readme
-    if (f === 'readme') return p1 + '/"'
+    // root readme or page.md
+    if (f === 'readme' || f === 'page') return p1 + '/"'
 
-    // nested readme
-    if (f.match(/readme$/)) return p1 + f.replace(/readme$/, '') + '"'
+    // nested readme or page.md
+    if (f.match(/readme$/) || f.match(/\/page$/)) return p1 + f.replace(/(readme|page)$/, '') + '"'
 
     // pretty url
     // if (pretty) return p1 + f + '/"'

lib/identify-pages.js

@@ -240,6 +240,11 @@ export async function identifyPages (src, opts = {}) {
       : files['page.html']
     if (htmlPage) htmlPage.type = 'html'
     /** @type {PageFile | undefined} */
+    const pageMd = opts?.buildDrafts
+      ? files['page.md'] ?? files['page.draft.md']
+      : files['page.md']
+    if (pageMd) pageMd.type = 'md'
+    /** @type {PageFile | undefined} */
     const readmePage = opts?.buildDrafts
       ? files['README.md'] ?? files['README.draft.md']
       : files['README.md']
@@ -281,7 +286,7 @@ export async function identifyPages (src, opts = {}) {
 
     const page = (conflict)
       ? null
-      : jsPage || htmlPage || readmePage
+      : jsPage || htmlPage || pageMd || readmePage
 
     if (page && page.type) {
       pages.push({
@@ -306,9 +311,10 @@ export async function identifyPages (src, opts = {}) {
       const isMarkdownFile = fileName.endsWith('.md')
       const isDraftFile = fileName.endsWith('.draft.md')
       const isReadmeFile = fileName === 'README.md' || fileName === 'README.draft.md'
+      const isPageMdFile = fileName === 'page.md' || fileName === 'page.draft.md'
 
       if (
-        !isReadmeFile && (
+        !isReadmeFile && !isPageMdFile && (
           (opts.buildDrafts && (isMarkdownFile || isDraftFile)) ||
           (!opts.buildDrafts && (isMarkdownFile && !isDraftFile))
         )

lib/identify-pages.test.js

@@ -15,12 +15,15 @@ test.describe('identify-pages', () => {
     assert.ok(results.layouts, 'Layouts are found')
 
     assert.ok(results.layouts['root'], 'A root layouts is found')
-    assert.equal(Object.keys(results.pages).length, 25, '25 pages are found')
+    assert.equal(Object.keys(results.pages).length, 27, '27 pages are found')
 
     assert.equal(results.warnings.length, 0, '0 warnings produced')
     // assert.equal(results.nonPageFolders.length, 4, '4 non-page-folder')
     assert.equal(results.pages.find(p => p.path === 'html-page')?.pageFile?.type, 'html', 'html page is type html')
     assert.equal(results.pages.find(p => p.path === 'md-page')?.pageFile?.type, 'md', 'md page is type md')
     assert.equal(results.pages.find(p => p.path === 'js-page')?.pageFile?.type, 'js', 'js-page is type js')
+    assert.equal(results.pages.find(p => p.path === 'page-md-page')?.pageFile?.type, 'md', 'page-md-page is type md')
+    assert.equal(results.pages.find(p => p.path === 'page-md-page')?.pageFile?.basename, 'page.md', 'page-md-page uses page.md')
+    assert.equal(results.pages.find(p => p.path === 'page-md-precedence')?.pageFile?.basename, 'page.md', 'page.md takes precedence over README.md')
   })
 })

test-cases/general-features/index.test.js

@@ -74,6 +74,14 @@ test.describe('general-features', () => {
         style: true,
         worker: true
       },
+      'page-md-page/index.html': {
+        client: false,
+        style: false,
+      },
+      'page-md-precedence/index.html': {
+        client: false,
+        style: false,
+      },
     }
 
     const files = await allFiles(dest, { shaper: fwData => fwData })
@@ -90,6 +98,17 @@ test.describe('general-features', () => {
             ? 'Generated'
             : 'Did not generate'} a global client`)
 
+    // Special test for page.md precedence over README.md
+    const pageMdPrecedencePath = path.join(dest, 'page-md-precedence/index.html')
+    try {
+      const pageMdContent = await readFile(pageMdPrecedencePath, 'utf8')
+      assert.ok(pageMdContent.includes('from page.md'), 'page.md content is rendered')
+      assert.ok(!pageMdContent.includes('from README.md'), 'README.md content is not rendered when page.md exists')
+    } catch (err) {
+      const error = err instanceof Error ? err : new Error('Unknown error', { cause: err })
+      assert.fail('Failed to verify page.md precedence: ' + error.message)
+    }
+
     // Special test for markdown-it.settings.js
     const mdSettingsTestPath = path.join(dest, 'md-page/markdown-settings-test.html')
     try {

test-cases/general-features/src/page-md-page/page.md

@@ -0,0 +1,3 @@
+# page-md-page
+
+This is an md page rendered from a page.md file.

test-cases/general-features/src/page-md-precedence/README.md

@@ -0,0 +1,3 @@
+# page-md-precedence (from README.md)
+
+This content should NOT appear - page.md takes precedence.

test-cases/general-features/src/page-md-precedence/page.md

@@ -0,0 +1,3 @@
+# page-md-precedence (from page.md)
+
+This content comes from page.md and should take precedence over README.md.