-
Notifications
You must be signed in to change notification settings - Fork 185
feat: add markdown output plugin to copy markdown files alongside HTML #882
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
/** | ||
* Plugin to output index.md files alongside index.html in the build directory. | ||
* This copies the original markdown source files to their corresponding locations | ||
* in the build output. | ||
*/ | ||
|
||
import fs from 'node:fs'; | ||
import path from 'node:path'; | ||
import { Plugin } from '@docusaurus/types'; | ||
import logger from '@docusaurus/logger'; | ||
|
||
/** Route prefixes to copy markdown files within. */ | ||
const PREFIXES = ['docs/', 'blog/']; | ||
|
||
type Context = Parameters<Plugin['postBuild']>[0]; | ||
|
||
function findMarkdownSource( | ||
routePath: string, | ||
{ siteDir }: Context, | ||
): string | null { | ||
for (const prefix of PREFIXES) { | ||
const routePrefix = `/${prefix}`; | ||
|
||
if (!routePath.startsWith(routePrefix)) continue; | ||
|
||
// Since routePrefix is absolute and routePath starts with routePrefix, it too must be absolute | ||
// meaning we can safely use path.relative to get the relative path | ||
const relativePath = path.relative(routePrefix, routePath); | ||
const sourceDir = path.join(siteDir, prefix); | ||
|
||
// Try direct file path first (e.g., /docs/tutorial/intro.md) | ||
const directPath = path.join(sourceDir, `${relativePath}.md`); | ||
if (fs.existsSync(directPath)) return directPath; | ||
|
||
// Try index.md in directory (e.g., /docs/tutorial/intro/index.md) | ||
const indexPath = path.join(sourceDir, relativePath, 'index.md'); | ||
if (fs.existsSync(indexPath)) return indexPath; | ||
} | ||
|
||
return null; | ||
} | ||
|
||
function copyMarkdownForRoute(routePath: string, context: Context): boolean { | ||
const { outDir } = context; | ||
|
||
// Find corresponding markdown source | ||
const mdSourcePath = findMarkdownSource(routePath, context); | ||
if (!mdSourcePath) return false; | ||
|
||
// Check if HTML output exists | ||
const htmlPath = path.join(outDir, routePath, 'index.html'); | ||
if (!fs.existsSync(htmlPath)) return false; | ||
|
||
// Copy markdown to output directory | ||
const outputMdPath = path.join(outDir, routePath, 'index.md'); | ||
fs.copyFileSync(mdSourcePath, outputMdPath); | ||
|
||
return true; | ||
} | ||
|
||
export default function markdownOutputPlugin(): Plugin { | ||
return { | ||
name: 'markdown-output-plugin', | ||
postBuild(context) { | ||
logger.info('Copying markdown files to build directory...'); | ||
|
||
// Filter to only routes in target prefixes | ||
const routes = context.routesPaths.filter((routePath) => | ||
PREFIXES.some((prefix) => routePath.startsWith(`/${prefix}`)), | ||
); | ||
|
||
// Process all routes | ||
let copiedCount = 0; | ||
for (const routePath of routes) { | ||
if (copyMarkdownForRoute(routePath, context)) { | ||
copiedCount += 1; | ||
} | ||
} | ||
|
||
logger.success(`Copied ${copiedCount} markdown files to build directory`); | ||
}, | ||
}; | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This probably doesn't play nice with i18n as those are prefixed by the language code. I think ideally we'd also serve the translated Markdown, so this should be updated to take that into account.