Please do a HTML export

[JuergenSchuster]

Hi guys,

I know you are living in a tech world and find markup cool, but me and my customer actually looking for a PL/SQL documentation tool like PL/DOC where I simply can generate an HTML file for documentation where the normal people like my customers and me :-) can simply invoke it with any browser. I would use PL/DOC but since Martin did that great job with Logger which we use heavily and PL/DOC looks quite old I'm hoping for a similar new standard solution for PL/SQL documentation from him. Let me assure you this is the only feature that separates you from a serious standard product in the PL/SQL world ;-)

Thanks, Juergen

[vincentmorneau]

The name of this project (plsql-md-doc) is almost misleading, because it doesn't just do markdown.

If you look into the template folder, you'll see package.md and toc.md. @martindsouza created default markdown templates, but these could be changed to generate HTML files as well.

This project uses handlebars to substitute the content of your PL/SQL doc into any file. For instance, the toc.md looks like:

# {{toUpperCase projectDispName}}

{{#each files}}
- [{{toUpperCase name}}]({{fileName}})
{{/each}}

But you could also create your own to look like:

<h1> {{toUpperCase projectDispName}} </h1>

<ul>
{{#each files}}
<li><a href="{{fileName}}">{{toUpperCase name}}</a></li>
{{/each}}
</ul>

I do agree it would be useful to provide a "customer" readable template out of the box.

[martindsouza]

We must produce a good looking HTML file, not just basic. @vincentmorneau what do you think about using a Bootstrap CDN to help with the HTML markup? This way you can get something that actually looks good? http://getbootstrap.com/getting-started/

Also: http://usejsdoc.org/about-getting-started.html

[vincentmorneau]

Yes I think that's a good idea. If you want I can help. Just assign me to this issue and I'll find some time soon to produce a quality HTML template.

[JuergenSchuster]

I guarantee you nobody cares about all the hard work in the backend, if you provide a nice, modern, responsive HTML Frontend. Everybody will like it and use it :-)

[JuergenSchuster]

I would call it Docer to have a famous pair that can benifit from each other: Logger and Docer ;-) This sounds like a strong couple you should both use in your projects :-)

[martindsouza]

@JuergenSchuster @vincentmorneau #48 may resolve this.

[vincentmorneau]

#56 resolved this issue.