Creating MkDocs Configuration File

MkDocs allows you to quickly create a website and run it locally on your computer. The source files for a project that uses MkDocs consists of Markdown content files and YAML configuration files.

Tip

Running a website locally requires MkDocs installed on your computer. See Installing MkDocs.

Procedure:

1. In the root location of your project, create a mkdocs.yml file.
2. Edit the file, paste the configuration provided below, and save the changes.
   mkdocs.yml

   site_name: My Website
   nav:
       - Home: index.md
   theme: readthedocs
   

3. Ensure the mkdocs.yml is added to the project. See Creating Read the Docs Configuration File.