feat: Terminal Documentation Viewer with GitHub Integration #3
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
- Implement GitHub API integration for documents repository - Add directory tree navigation with [DIR] and [MD] indicators - Implement VitePress syntax cleaning (frontmatter, containers) - Add terminal Markdown rendering using marked-terminal - Support browser fallback on errors - Add retry mechanism for failed network requests Features: - Browse documentation categories - Navigate directory structure - View Markdown files in terminal - Clean VitePress-specific syntax - Fallback to browser when needed Closes #TBD
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.
Summary
Add comprehensive terminal-based documentation viewer that allows users to browse and read Markdown files from the nbtca/documents repository directly in the terminal, eliminating the need to open a browser.
Features Implemented
Technical Details
cleanMarkdownContent()to strip VitePress-specific syntaxbrowseDirectory()function for stateless navigationTesting Instructions
pnpm run devFiles Changed
src/features/docs.ts: Complete rewrite with full implementationRelated Issues
Implements terminal documentation viewing as requested for better developer experience and terminal-first workflow.