Skip to main content

Techdocs

@charmed_life/techdocsv2026.08.03.1· 2mo agoBEHAVIORS
01README

Search and read local markdown documentation from a git repository. Pulls latest from master/main before every operation.

02Behaviors1
@charmed_life/techdocsv2026.08.03.1techdocs.ts

Global Arguments

ArgumentTypeDescription
repoPathstringAbsolute path to the local docs git repo
branchstringBranch to pull from
fn search(pattern: string)
Pull latest docs and search markdown files by keyword or regex pattern
ArgumentTypeDescription
patternstringKeyword or regex pattern to search for
fn read()
Pull latest docs and read the full content of a markdown file by path

Resources

search-results(infinite)— Search results from querying markdown files
doc(infinite)— Full content of a single markdown document
03Stats
B
80 / 100
Downloads
28
Archive size
5.7 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License1/2partial

    no SPDX license declared

  • Verified public repository0/2missing
04Platforms
05Labels