Be part of JetBrains PHPverse 2026 on June 9 – a free online event bringing PHP devs worldwide together.

smarru's avatar

laravel.com documentation

I would like to mimic how larvel.com documentation on our website. I see that the soruce is at https://github.com/laravel/docs can anyone please point me to how this gets build and deployed? Is it using mkdocs or Sphinx? I am interested to see how the headers, navigation and theme of the site is preserved in auto-generation docs.

Thanks, Suresh

0 likes
8 replies
mstnorris's avatar

@smarru As far as I know, the documentation is written by Taylor and the community; I don't think a package was used. AFAIK Jack McDade designed the site.

As for the API that was generated using Sami.

mstnorris's avatar

@deringer that doesn't generate the documentation, that's just a glorified TOC.

I see that the soruce is at https://github.com/laravel/docs can anyone please point me to how this gets build and deployed? Is it using mkdocs or Sphinx?

The fact they mention MkDocs means that they are indeed looking to automatically generate documentation (as a whole) not just the front page (table of contents).

alenabdula's avatar

I would like to mimic how larvel.com documentation on our website.

You can use a static site generator, like Jekyll.

1 like
smarru's avatar

Thank you all for all the insights, its very helpful. To clarify, we have a laravel based portal (https://seagrid.org/) and have styled the theme. For the documentation tab we currently take the users to a confluence wiki. Rather I would like to get the documents written in markdown and deployed as static html. Jekyll, mkdocs like tools help me go from markdown to html. The unknown to me is how to use the static header and footer so users do not feel they are in a different land for documentation.

Appreciating all the responses,

mstnorris's avatar

As with the Laravel docs, create a directory called docs and use a master template that includes your standard header and footer.

That part is the least complicated. :)

MikeHopley's avatar

Jekyll, mkdocs like tools help me go from markdown to html.

Just FYI:

You can easily convert markdown to HTML without those tools, if you prefer. Just use a package like commonmark.

1 like

Please or to participate in this conversation.