-
Notifications
You must be signed in to change notification settings - Fork 44
feat: add docs capture and export functionality for llmstxt standard #1626
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
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,58 @@ | ||
| import * as crypto from 'crypto'; | ||
| import * as fs from 'fs'; | ||
| import * as path from 'path'; | ||
|
|
||
| import type {MdastNode} from './types'; | ||
|
|
||
| export const CAPTURE_TREE_VERSION = 1; | ||
|
|
||
| function hashString(value: string): string { | ||
| return crypto.createHash('sha1').update(value).digest('hex'); | ||
| } | ||
|
|
||
| export function captureDirForSite(siteDir: string): string { | ||
| return path.join(siteDir, '.docusaurus', 'llms-export', 'trees'); | ||
| } | ||
|
|
||
| export function capturedTreePathForSource( | ||
| sourceAbsPath: string, | ||
| siteDir: string, | ||
| ): string { | ||
| let absolutePath: string; | ||
| try { | ||
| absolutePath = fs.realpathSync(sourceAbsPath); | ||
| } catch { | ||
| absolutePath = path.resolve(sourceAbsPath); | ||
| } | ||
| return path.join( | ||
| captureDirForSite(siteDir), | ||
| `${hashString(absolutePath)}.json`, | ||
| ); | ||
| } | ||
|
|
||
| export function wrapCapturedTree(tree: unknown): { | ||
| version: number; | ||
| tree: unknown; | ||
| } { | ||
| return {version: CAPTURE_TREE_VERSION, tree}; | ||
| } | ||
|
|
||
| export function unwrapCapturedTree(payload: unknown): MdastNode | null { | ||
| if (!payload || typeof payload !== 'object') return null; | ||
|
|
||
| const record = payload as Record<string, unknown>; | ||
|
|
||
| // Handle versioned format | ||
| if ('version' in record && 'tree' in record) { | ||
| const version = Number(record.version); | ||
| if (version !== CAPTURE_TREE_VERSION) return null; | ||
| return (record.tree as MdastNode) ?? null; | ||
| } | ||
|
|
||
| // Legacy format support (version 1 only) | ||
| if (CAPTURE_TREE_VERSION === 1) { | ||
| return payload as MdastNode; | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.