Skip to content

Enable specifying title header style, default being setext #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
didix21 merged 1 commit into from
Jun 2, 2025
Merged

Enable specifying title header style, default being setext #112

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions mdutils/mdutils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ class MdUtils:
- **author:** it is the author fo the Markdown file.
- **header:** it is an instance of Header Class.
- **textUtils:** it is an instance of TextUtils Class.
- **title:** it is the title of the Markdown file. It is written with Setext-style.
- **title:** it is the title of the Markdown file. It is written with Setext-style unless otherwise specified.
- **table_of_contents:** it is the table of contents, it can be optionally created.
- **file_data_text:** contains all the file data that will be written on the markdown file.
"""

def __init__(self, file_name: str, title: str = "", author: str = ""):
def __init__(self, file_name: str, title: str = "", author: str = "", title_header_style: str = "setext"):
"""

:param file_name: it is the name of the Markdown file.
Expand All @@ -58,7 +58,7 @@ def __init__(self, file_name: str, title: str = "", author: str = ""):
self.file_name = file_name
self.author = author
self.textUtils = TextUtils
self.title = str(Header(level=1, title=title, style=HeaderStyle.SETEXT))
self.title = str(Header(level=1, title=title, style=HeaderStyle[title_header_style.upper()]))
self.table_of_contents = ""
self.file_data_text = ""
self._table_titles = []
Expand Down
Loading