mkdocs_testing

Welcome to Smile4yourself Web Docs

Purpose: to figure out how to create a documentation website with mkdocs

For full documentation visit mkdocs.org.

Folder layout for Creating a Website is here

/main
    docs/
        index.md  # The documentation homepage.
        ...       # Other markdown pages, images and other files.
ven
    include
    lib
    pyvenv.cfg
    

Steps to create a documentation website with mkdocs, a python package

  1. create a new Github repo

mkdocs documentation

https://www.mkdocs.org/

information on the Material Theme for mkdocs

https://squidfunk.github.io/mkdocs-material/