Documentation using MkDocs

  • Requirements — Statements that identify the attributes, capabilities, characteristics, or qualities of a system. This is the foundation for what will be or has been implemented.
  • Architecture/Design — Overview of software. Includes relations to an environment and construction principles to be used in the design of software components.
  • Technical — Documentation of code, algorithms, interfaces, and APIs.
  • End-user — Manuals for the end-user, system administrators, and support staff.
  • Marketing — How to market the product and analysis of the market demand.
XD-Adobe
MkDocs is awesome

Beginning with MkDocs

Let me assume you have python installed if not, please do well to get python install on your device by click here. Alright after installing your python the next thing to get up is your “pip” and If you’re using a recent version of Python, the Python package manager, pip, is most likely installed by default. However, you may need to upgrade pip to the lasted version, visit Installing pip to know more.

Command to install pip.
project directory created
Project Folder
Starting your live serve for MkDocs
Starting site directory
Welcome to MkDocs
My New Docs
Display effect

Adding page

Now add a second page to your documentation and creating an internal link within your site. This [home](about.md) adds a link to your documentation, and creating a page requires you to edit your config file which is in mkdocs.yml like this:

Nav Bar with MkDocs

Theming our documentation

One amazing thing with MkDocs is the ability to add a theme to your docs and thanks to readthedocs community for providing us with an awesome theme. Edit the mkdocs.yml file and add a theme setting:

Adding theme using VS Code
ReadTheDocs Theme

--

--

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store