Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
we are planning to write our software documentation in Markdown, but to provide a clickable webview we need to convert the Markdown documents to a nice looking set of HTML pages.
In our workflow we tend to write the documentation and deliver the documenation together with the sourcecode and binaries to our clients. I found a lot off 1-page convert to html programs, but i am wondering if there is a good converter that takes markdown pages and styling elements and is able to convert that to a workable site, including navigation elements such as sub-pages etc?
Is this an end-user documentation or an API-documentation for developers?
For first case I'd suggest looking at Wiki software with Markdown support.
For second case, you should really mention which programming language.
You should check out Gollum. It's the software that powers Github's wikis. It converts a git repository of text files into a wiki.
Here is a blog that introduces several tools that maintain documentation with Markdown. ScreenSteps seems to fit you the best.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
Improve this question
I am looking to render SQL code on my webpage. I am making tutorials and i would like to display SQL snippets to my visitors. Are there some librairies out there or best practices to do that?
Since this is StackOverflow I will recommend the one that StackExchange is using - Google's Code Prettify library, which supports SQL.
You would have to include the library to your site:
<script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js"></script>
And then write your example
<pre class="prettyprint">
SELECT name FROM users;
</pre>
Usually when you want to neatly display code on a webpage, CSS isn't enough. If you want more sophisticated code coloring and formatting, you'll most likely need to write javascript in order to detect keywords, values strings etc. Luckily with the dev community being what it is, there are already options to do this for many different languages. I'd recommend SyntaxHighlighter as it offers support for many languages, it's easy to use and customize.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 8 years ago.
Improve this question
I've been searching lately for different way to present a user manual that is easy to use and understand.
At first, I tought that the Microsoft Help files would be great, since I knew my way around basic HTML. Little did I knew that Microsoft Help Workshop was a bit more complicated than simply taking HTML and processing it. I had multiple problem while trying to ajust the different styles and classes applied to my HTML.
What would be the best tool to use to convert an existing HTML project (HTML, CSS and basic Javascript) to a compiled .CHM file?
If it is not possible, what option would be worth exploring when making maintainable user manuals?
Thanks.
I would explore using pandoc to convert your html or markdown to docbook or pdf, or any of 100s of other formats.
There are various tools available to do that. Few noteworthy are: nDoc or DocBook or FAR HTML or doxygen or Microsoft's SandCastle
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I'm in the progress of implementing a built-in help system based on QtHelp into my application. Since QtHelp is based on Qt's help collection files, I need to produce a set of HTML pages.
Since I won't be writing the documentation alone (a few of my colleagues will write, too), I am looking for the best way to produce these files.
We are internally using a Wiki, and I know that the documentation should be written in some kind of markup language instead of giving all authors a WYSIWYG HTML editor.
So my question is, are there tools out there which help with the process of generating documentation that can be exported as a set of HTML files, and possibly, as PDFs, too?.
Thanks in advance!
Update:
I'm already using Doxygen for C++ documentation generation. But I'm not exactly looking for an API-Documentation generator, but something like LaTeX, which allows you to format the documentation contents like a markup document (much like a Wiki).
I hate to answer my own questions, but we eventually decided to settle for LaTeX.
In the past we used a Wiki (MediaWiki and DokuWiki) for documentation, but that proved to be problematic as soon as you wanted to print or ship the documentation in a decently formatted form (PDF guide for instance).
LaTeX is not much more complex compared to a Wiki markup language, but produces beautiful PDF files, and there are also a series of LaTeX-to-HTML compilers, which produce decent HTML documentation with graphics, Tables Of Contents and clickable links and sections.
If you're writing your application in JavaScript, you might wish to look at JSDoc.
For other languages, Doxygen is a good choice, too. http://www.doxygen.nl/
Doxygen can output HTML and PDF formats =)
For a more comprehensive list of documentation generators, Wikipedia and Google are your friends. http://en.wikipedia.org/wiki/Comparison_of_documentation_generators
Good luck
Edit
Ok, Thread poster has announced he used Doxygen already. However, the wikipedia page still stands, I guess
Might I ask what language you're working with?
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 8 years ago.
Improve this question
I've found wkhtmltopdf, which looks good on the surface and works fine in very small cases, but it doesn't provide any real css control over the rendering.
By that I mean it doesn't use the print media type and page breaks are not respected, as well, on windows you can't control the names of some header/footer variables, or generate a TOC off of teh h1 tags.
Are there any real open source alternatives, I've tried xhtml2pdf which is a python library actually called pisa, but it requires reportlab which doesn't play nice windows.
I'm actually programming in .net but if its good and open source, the language isn't a huge issue.
This is an old stackoverflow question, but because google took me here, it could be helpful for somebody else.
Weasyprint should support what the author was looking for.
It supports print css features like page break.
Try weasyprint
It turns out there was no open source alternative that was simpler, but on windows wkhtmltopdf is just not the best thing, so we paid for a better solution.
Winnovative's PDF library is what we used
While it is not open-source, I use ABCPDF. I have a template page in .NET that I use for a wrapper to set up a custom stylesheet for generating PDFs only.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 6 years ago.
Improve this question
I'm looking for a library or a collection of libraries that work together with the following requirements:
HAML and SASS can be used.
Have a small server capability to see HAML/SASS compiled every time I refresh my browser. (I don't want to start a fresh Rails app, though.)
Works with popular CSS frameworks. (Doesn't have to be all, but major ones like 960gs and Blueprint)
Compass seems to be promissing, but it doesn't seem to support HAML. At least I'm looking for information that make Compass and HAML together.
Edit chriseppstein gave the list of cool stuff. I'll make a link to each one.
http://staticmatic.rubyforge.org/
http://github.com/tdreyno/middleman
http://nanoc.stoneship.org/
http://webby.rubyforge.org/user-manual/
http://github.com/jlong/serve
There are several of these:
staticmatic
middleman
nanoc
webby
All of these support haml and sass and can be easily configured to work with compass too.
Additionally, there is "serve", which is just a simple webserver.
I use Prepros, and I'm satisfied with it.