Skip to content

franco-bianco/docsmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docsmd

Converts documentation sites to a single Markdown file.

Supported site types:

  • GitBook
  • Mintlify
  • Postman (API documentation)
  • Waku

The site type is detected automatically.

Usage

go run main.go <docs-url>

The output file is written to output/ and named after the site hostname:

go run main.go https://docs.slash.com/introduction
# → output/slash_docs.md

go run main.go https://docs.tempo.xyz/
# → output/tempo_docs.md

How it works

  1. Fetches the base URL and detects the site type
  2. Extracts all page URLs (from navigation, sitemap, or API depending on the site type)
  3. Renders each page in a headless browser, extracts the article content, and converts it to Markdown
  4. Concatenates all pages into a single .md file

Dependencies

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages