CODEWITHSUNDEEP
htmlluasyntax-highlightingpretty-print
jay
jay

Reputation: 213

Pretty-print Lua source-code in external file, without embedding it in the HTML file

Since my experience with HTML is fairly rudimentary (and pretty old), I am not sure if my requirement is realistic.

Lets say that I have quite a few files containing Lua source-code, and all of them have the ".lua" extension and available in a particular subdirectory. What I'd like to do is create a static index.html file, which when loaded in a browser, would show the list of the lua source-code files in a drop-down. Once one of the source-code files is selected, I'd like that the file gets loaded into an "area" on the same page, and is pretty-printed, i.e. with syntax-highlighting in browser. I was wondering if I could use something like the google-code-prettyfy for the syntax-highlighting part ? Also, I am not clear if an external lua sourcecode file can be loaded, and displayed within a certain region of html page as being rendered. If yes, would appreciate elaboration on the how part.

Upvotes: 0

Views: 485

Answers (1)

RBerteig
RBerteig

Reputation: 43366

A tool like LDoc can be used to accomplish a lot of what you want, much as Doxygen would be used for a C language source kit.

Both are heavily driven by inclusion of specially formatted comments that carry documentation.

I know Doxygen can fold source code into the generated document set, I don't recall about LDoc. Both are actively under development.

It isn't necessarily a bad idea to use both tools on a project, especially if you have C source code implementing Lua modules. You could use Doxygen to build the overall document tree for your engine and C modules, and LDoc to build documentation of the Lua parts. It should be possible with a little care and configuration of both tools to get them to play well together.

Upvotes: 1

Related Questions