Hey all, in Laravel, what is a simple approach to create tech documentation from markdown?
We are launching a service. It will have at /documentation/ some documentation for our API. It's not super complex.
I'm looking to write markdown files, maybe use Folio, and generate tech docs (ideally using tailwindcss) with some standard clean template already written. Doesn't need to be fancy or have javascript, just documentation with some code examples. (As an example of something I don't think I'll use, the TailwindUI documentation template uses React, and that's too complex for this, simple Blade file templates ideally.)
How would you approach this?
@petervandijck Quick heads-up, my idea might not match your expectations.
I prefer to use README.md for my project to write all the technical documents (mostly about the project, how to start/install, how to run the TDD.... etc) unless it's important to expose publicly.
I feel it's the most pragmatic way to write up the documents instead of spending a good amount of time on extra setup.
Thank you!
Yes the idea of /documentation/ is that it is public documentation of our API.
(I do have internal readme tech docs already)
My default approach will be:
But I was thinking there must be something simple out there that's even nicer/easier to set up?
@petervandijck I never tried, but I know this package exists for writing documentation for a whole already: https://larecipe.saleem.dev/
Have you checked that?
I am pretty sure few more :)
@tisuchi Oh that looks nice!
Please or to participate in this conversation.