S
S
Sergey Romanov2015-10-14 15:16:50
PHP
Sergey Romanov, 2015-10-14 15:16:50

Automatic generation of documentation from markdown to a static site. What to use?

There is a project. Everything is commented out and PHPDoc is used to generate the API documentation. But there is a need to create something like a book, with different thematic articles and examples. I would like to use something specialized for this and something that can automate the process.
I tried Jekyll, Daux.io and Read The Docs. I liked the last one, but I couldn't get it to work on their server. All the time the import build failed.
Can you recommend a good product?

Answer the question

In order to leave comments, you need to log in

3 answer(s)
F
Foo Bar, 2015-10-14
@atomheart

Do you want to try to do it yourself? It's not difficult after all. Here What can be used as help for a project in Django? I gave an example of how you can quickly build your wiki on Django (sharpened for viewing).
Of the solutions in Python, there is a simple custom utility: www.mkdocs.org
You slip it a folder with documents, it generates documentation in html for you.

A
AVKor, 2015-10-14
@AVKor

try pandoc.

E
Edward Tibet, 2016-02-09
@eduardtibet

You will first decide on the source format that you will support, and then look for an application to display information. Interested in Markdown?
For example, docs.raneto.com/what-is-raneto

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question