Example

This is a short example to demonstrate caption features using MkDocs in Win10.

1. Navigate to the folder to contain the repository folder
2. git clone https://github.com/flywire/caption.git
3. cd caption
4. E:\caption>py -m venv .venv
5. E:\caption>.venv\scripts\activate
6. (.venv) E:\caption>

Follow https://www.mkdocs.org/getting-started/ to install and test MkDocs

1. (.venv) E:\caption>pip install mkdocs
2. (.venv) E:\caption>mkdocs serve
3. Open http://127.0.0.1:8000/ in your browser, and you'll see the default home page being displayed

Note: Load caption module

The Caption repository now containd a Docs folder and a mkdocs.yml file with the configuration.

1. Replace the following files for the example then serve the documents again and open the site:

docs\index.md - See #3#issuecomment-660130402

mkdocs.yml

site_name: captionTest
#theme:
#    name: material

# extra_css: [extra.css]

markdown_extensions:
    - admonition
    - attr_list
    - codehilite
#    - fenced_code
    - caption:
        captionNumbering: true
#    - yafg:
#         figureNumbering: true

nav:
    - Home: index.md

Save the following image as docs\images\gplv3.png