feat!: add get static paths helper function (#688) #693
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR adds utilities for generating Next.js static paths from MDX documentation files. The implementation provides a clean abstraction for scanning directories, mapping MDX files to slugs, and building static paths for static site generation.
Key Changes:
- New utility to recursively scan directories and map MDX file paths to URL slugs based on their location and filename
- Helper function to resolve absolute paths from relative directory segments
- Main function to generate Next.js-compatible static paths for all discovered MDX files
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/utils/mdx/staticGeneration/staticPaths.ts | Exports main helper that orchestrates MDX discovery and static path generation |
| src/utils/mdx/files/resolveRelativeDirs.ts | Provides path resolution from relative directory segments to absolute paths |
| src/utils/mdx/files/mapMDXSlugByFilePaths.ts | Implements recursive directory scanning and slug mapping for MDX files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
frano-m
force-pushed
the
fran/688-staticpaths
branch
from
af1dbaf to
2e2696a
Compare
frano-m
changed the title
NoopDog
approved these changes
Oct 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #688.
This pull request introduces new utilities for working with MDX files in the documentation system and provides a helper for generating Next.js static paths for MDX pages. The main changes add functions to recursively map MDX file paths to slugs, resolve absolute directories from relative segments, and build static paths for static site generation.
MDX file mapping and path utilities
mapMDXSlugByFilePathsinsrc/utils/mdx/files/mapMDXSlugByFilePaths.tsto recursively scan directories for.mdxfiles and map each file path to its slug, which is derived from its relative directory segments and filename.resolveRelativeDirsinsrc/utils/mdx/files/resolveRelativeDirs.tsto construct an absolute path from an array of directory segments relative to the docs root.Static site generation support
buildStaticPathsinsrc/utils/mdx/staticGeneration/staticPaths.tsto generate Next.js-compatible static paths for all MDX files found under specified relative directories, using the slug mapping utility.