pasqua101 / txt-to-html-converter Goto Github PK

When looking at the source code, I felt that the comments made it a little cluttered.
Commenting is good for explaining why a program does something a certain way and documenting what a function does, but there's no need to explain what every single line of code is doing.

I am going to add a feature that can detect the bold markdown tag (**word**) and convert it to the <strong> tag in HTML. This will be a simple addition to the parse_md function that I already have.

From the release 0.1 specifications:
"10. every blank line should be considered a paragraph limit"

Input:

This is paragraph 1.
This is part of paragraph 1.

This is paragraph 2.
This is part of paragraph 2.

Expected output:

<p>This is paragraph 1. This is part of paragraph 1.</p>
<p>This is paragraph 2. This is part of paragraph 2.</p>

Output:

<p>This is paragraph 1.</p>
<p>This is part of paragraph 1.</p>
<br><p>This is paragraph 2.</p>
<p>This is part of paragraph 2.</p>

The release 0.1 spec doesn't mention using <br> tags between paragraphs, so no need for them.

Hey, @Pasqua101 I'd like to work on a new feature that will allow TOML configuration files to be passed as arguments, allowing for multiple arguments to be parsed easily.
The argument will be accessible using either -c or --config and I'll be using the tomllib library to parse the config files.

Let me know what you think!

I would like to add in the feature for my program to detect the use of `` for code blocks in Markdown, as well as the use of 3 backticks for a fenced code block. When the backtick is detected, it will rend the line as <code> .... text ... </code>

Try to convert a .txt file nested in a directory.
It will result in an error:

The README doesn't explain how to install/build the txt_to_html program locally.

How I understood the README:
Step 1: Install Python locally
Step 2: Add Python to environment variables
Step 3: Run the program using txt_to_html filename.txt or txt_to_html foldername

(When and how was the program built?)

(For what it's worth, I ran the program by downloading the .py file and running it with python txt_to_html.py filename.txt)

I'm adding in the optional feature where the user can use a -l or --lang argument that can change the lang attribute in the HTML tag. If the user doesn't use the argument, by default it'll use en-CA

Mentioned this in issue #20, also left a TODO comment as a reminder to look at the branch for issue #16 and the refactoring branch.

Basically an expansion of #20, however this time instead of generating a table of contents. I would like it to actually render the table of contents on the side of the page.

Plans for working on this feature:

1. Create argument to take in a file containing a python dictionary
2. Dictionary would have to take in 2 keys and 2 respective values, 1 key is the label , "home", and the other is the URL , "/". Basically links to other pages that can be generated, as the program can take in several files at a time.
3. Have code generate side bar at the top of the HTML template before the body of the HTML is generated

• Code generates the table of contents in a list with the a tag

I'd like to add the ability for the program to convert .md files to .html files.
Additionally, any links in the .md file following the markdown link syntax will be converted to <a href='...'> ... </a> tags.
The way .txt files are processed will be unchanged.

Input:

Message from running the tool:

Output:

The tool processes a directory correctly, but it should only output conversion messages when processing .txt files.

Doing some general cleanup to my program. Mainly just splitting up the main txt_to_html.py file into separate files, so it isn't as cluttered.

I will be adding in support for the horizontal rule in Markdown. Meaning that this --- will be converted to <hr> in HTML.

Since all the code has been moved into a new file. The import statements in the testers, must be updated.