Skip to content

Commit 20ad9e3

Browse files
3sbwyadidix21
authored andcommitted
Update documentation for MdUtils filename param
1 parent c5bc03e commit 20ad9e3

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,15 +98,18 @@ This is an example of a markdown file created using the mdutils python package.
9898
## Create Markdown files
9999

100100

101-
``create_md_file()`` is the last command that has to be called.
101+
Using the `MdUtils` class, we can define a new Markdown object by specifying its filename and optionally it's title and author. The filename is used as the path for creating the the Markdown file. From here, Markdown syntax can be created using the provided methods in the `MdUtils` class (see below for examples). Finally, `create_md_file()` is called to create the file at the specified path.
102+
102103

103104
```python
104105
from mdutils.mdutils import MdUtils
105106

106107

107108
mdFile = MdUtils(file_name='Example_Markdown',title='Markdown File Example')
109+
# Additional Markdown syntax...
108110
mdFile.create_md_file()
109111
```
112+
110113
## Create Headers
111114

112115

0 commit comments

Comments
 (0)