Skip to content

webdevsuperfast/dash-tailwindcss-docs

 
 

Repository files navigation

dash-tailwindcss-docs

Generate docset for Kapeli's Dash Mac app from the Tailwind CSS docs.

Usage

API docs are scraped from tailwindcss.com/docs using Wget then moved to the Tailwind_CSS.docset/Contents/Resources/Documents folder. Do not directly modify any of the files under Tailwind_CSS.docset, they will be overwritten by the scripts.

git clone https://github.com/bkbooth/dash-tailwindcss-docs.git
cd dash-tailwindcss-docs
yarn
yarn build

This will scrape the Tailwind CSS docs into a local folder, copy and transform all of the HTML files, then parse the HTML files' navigation menu to get a list of entries to populate the docset database.

The scraper will download the latest version of the API docs.

Prepare the docset for Dash by archiving after generating with this command:

tar --exclude='.DS_Store' -cvzf Tailwind_CSS.tgz Tailwind_CSS.docset

Prequisites

About

Generate Dash docset for Tailwind CSS docs

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 99.1%
  • Other 0.9%