Fork of Tangara with customizations
Je kunt niet meer dan 25 onderwerpen selecteren Onderwerpen moeten beginnen met een letter of nummer, kunnen streepjes bevatten ('-') en kunnen maximaal 35 tekens lang zijn.
 
 
 
 
 
 
tangara-fw/tools/luals-gendoc
Tom Kirchner d6db4b0826 Add missing copyright/license headers 10 maanden geleden
..
README.md Add reference doc regen instructions 1 jaar geleden
gendoc.lua Add missing copyright/license headers 10 maanden geleden
json.lua Use luals-stubs as the source of truth for docs, instead of maintaining 2 jaren geleden

README.md

Prerequisites

  • lua-language-server
  • a Lua interpreter version >= 5.2

Regenerating the Lua reference docs

  1. Invoke lua-language-server to parse our stubs, generating json output:
$ lua-language-server --doc=../../luals-stubs
  1. The output will include the path to the raw json data. This will be a path like '/home/jacqueline/Development/lua-language-server/log/doc.json'. Pipe this file to gendoc.lua. The output will be quite long; consider piping to less for testing.
$ cat /home/jacqueline/Development/lua-language-server/log/doc.json | ./gendoc.lua | less
  1. If updating the public-facing docs on cooltech.zone, place the resulting output in 'content/tangara/docs/lua/reference.txt'.