using-python-comments-to-generate-a-markdown-file

Using Python Comments to Generate Markdown Anchors and Links.

• Prerequisites
• Setup
• Running the Script

Prerequisites

1. A completed install of Python 3.x.
2. The .py file with properly formatted comments.

Formatted Comments:

# Using function_name():
# Using an empty collection_type:
# Using collection_type with elements:
# Using collection_type Comprehension:

Setup

1. Under your USERPROFILE, extract the using-python-comments-to-generate-a-markdown-file-main.zip.

Example:

C:\Users\nso89\using-python-comments-to-generate-a-markdown-main

Running the Script

1. Open cmd.exe and change the folder to the using-python-comments-to-generate-a-markdown-file-main folder.

Example:

C:\Users\nso89>cd using-python-comments-to-generate-a-markdown-file-main

2. Start the main.py script.

C:\Users\nso89\using-python-comments-to-generate-a-markdown-file-main>python main.py

3. Suppose the path to your .py file is C:\Users\username\Projects\python-cheatsheet-main\using-example\example.py, just provide the path without the USERPROFILE.

Example:

File Path: Projects\python-cheatsheet-main\using-example\example.py

4. The main.py script generates the example.md file (the .md file will be generated in the same folder as the .py file).

Example:

C:\Users\nso89\Projects\python-cheatsheet-main\using-example\example.md