Building Your Documentation With MkDocs
00:05 At this point, you should have written all your documentation pages and the project structure file. At the end of this step, you’ll have built your documentation and be ready to deploy it online.
You’ve already built your documentation using the
serve command. This command builds a development version of your documentation and makes it available locally on the URL you used earlier. Serving your documentation like this is helpful during development because any changes you apply will update straight away. However, once you’ve finished developing your documentation, you’ll want to build it without starting a server.
After all, MkDocs is a static-site generator that allows you to create documentation that you can host without running a server. To build the documentation and create the
site/ directory that will contain all the necessary assets and static files, you can use the
When you build your documentation with this command, MkDocs creates a
site/ directory. That directory will contain all of the documentation converted to HTML pages, as well as the static assets that are necessary to build a Material for MkDocs theme, as seen on-screen.
Become a Member to join the conversation.