Symfony: Generate documentation from markdown with Table of contents

Question

What are the best practices for generating a documentation (of a tool/service) in Symfony?

To be a little more explicit:

I want to use Markdown to write a documentation
I will probably have more files (about 5-10 files) with different topics, located in one folder (or maybe even in subfolders)
In the documentation files I would like to have reference links to other documents
I would like to automatically generate a complete documentation from that source. This should contain:
- Table of contents (with links to the headlines of the documentation files)
- Generated HTML-Files with separate links for all source files

I've already searched the web, but only found those libraries that are only partly satisfying my needs:

Anybody has any ideas or already use a bundle?

Jasson Rojas · Accepted Answer · 2018-01-12 16:41:20Z

1

i use phpDocumentor bundle for symfony: https://symfony.com/projects/phpdocumentor

answered Jan 12, 2018 at 16:41

Jasson Rojas

2993 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

codiga Over a year ago

Thanks for the link, but this is not what I was asking for. I'm not looking for something to document my php-code. I want to document the usage of my tool, which I build with symfony. So it is addressed to the user instead of the developer.

Collectives™ on Stack Overflow

Symfony: Generate documentation from markdown with Table of contents

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related