Skip to content
This repository has been archived by the owner on Aug 4, 2023. It is now read-only.

Latest commit

 

History

History
12 lines (9 loc) · 897 Bytes

README.md

File metadata and controls

12 lines (9 loc) · 897 Bytes

Purpose

This tool is meant to clone the sumneko/lua-language-server wiki's repo and output the documentation as HTML files, instead of Markdown. It is possible that this could be used for other repositories by switching out the links defined near the top of index.ts, but I don't really support it. This tool is just a quick script to do a relatively simple job.

Usage

You will need nodejs and git.

  1. Clone the repo
  2. npm i to install dependencies
  3. tsc to compile TS into JS
  4. npm run generate to generate HTML files or npm run generate-zip to get the files as a zip

You should now have a html/ directory or doc.zip that contains all of the HTML and CSS, as well as a sub-directory images/ with all of the images from the wiki.