Only showing the level 2 headings is a bit restrictive. Maybe allow for two-element list or a tuple defining the top and bottom level of the range of headings that the user would like to show in the TOC. The Table of Contents would then be a nested-list of headings. Default would remain just the level 2 headings, with the list/tuple being a range of a single value [2, 2].

I found the need to create a list of checkboxes for task management. PR #55 wsa to create a list direclty, this PR is to create a CheckBox Instance than can be used with MDlist directly, so each checkbox can be checked or unchecked individually.

Tests are based on InlineText's tests, everything passing.

I found the need to create a list of checkboxes for task management. This PR includes a quick way to create a list of all checked or all un-checked boxes, based on MDList class.

Tests are based on MDList's tests, everything passing.

I'm trying to convert all of the existing Sample Programs Docs Generator code over to the new library, but there's a problem. The library doesn't support certain actions that we'd like to replicate. One of those actions is creating list items with multiple links. It never dawned on me that we would need to support this, so the existing MDList code only supports InlineText elements. I'm thinking that MDList should support Paragraphs instead.

For reference, SnakeMD doesn't support this:

- :white_check_mark: [Hello World in C\*](https://sample-programs.therenegadecoder.com/projects/hello-world/c-star) [[Requirements](https://sample-programs.therenegadecoder.com/projects/hello-world)]

I get the following error when I try to import snakemd in AWS Lambda: Syntax error in module 'cost_report': invalid syntax (generator.py, line 604)

Locally, the file gets created normally. Any ideas?

Here's the current chunk of code I'm trying to write:

def _generate_program_list(language: LanguageCollection) -> MDList:
    """
    A helper function which generates a list of programs for the README.
    :param language: a language collection
    :return: a list of sample programs list items
    """
    list_items = list()
    for program in language.sample_programs:
        program_line = Paragraph([])
        readable_name = program.normalized_name.replace("-", " ").title()
        program_name = f"{readable_name} in {language.get_readable_name()}"
        program_link = InlineText(program_name, url=program.sample_program_doc_url)
        if not program_link.verify_url():
            program_line.add(":warning: ")
            program_link = InlineText(program_name, url=program.sample_program_issue_url)
        else:
            program_line.add(":white_check_mark: ")
        program_line.add(program_link)
        program_line.add(" [Requirements]")
        program_line.insert_link("Requirements", program.sample_program_req_url)
        list_items.append(program_line)
    return MDList(list_items)

All of this to just generate a couple of sentences. The main trouble I'm running into pertains to #19. But even beyond that, it's really hard to tell what this code is even supposed to do. Part of me thinks that the pattern should be to avoid InlineText at all costs. I feel like this would be a lot more readable if the user was able to construct their text first. That way, we could leverage various paragraph functions to modify the text after the fact. One idea I currently have is having a parameter which allows the user to test if their link is valid as they insert it. Right now, insert_link returns a Paragraph, so you can chain the calls. Maybe we need a function that checks all links in a paragraph...

When using Markdown extensions like pymdownx.superfences and pymdownx.tabbed, like we do via Material for MkDocs, an optional indent size paramter now ensures compatibility.

Spoken in Markdown:

=== "Tab 1"

    | Header 1  | Header 2 |
    | --------- | ---------|
    | row1col1  | row1col2 |

== "Tab 2"

    | Header 1  | Header 2 |
    | --------- | ---------|
    | row1col1  | row1col2 |

I am using .output_page and I get the following error: """ C:\ProgramData\Anaconda3\lib\encodings\cp1252.py in encode(self, input, final) 17 class IncrementalEncoder(codecs.IncrementalEncoder): 18 def encode(self, input, final=False): ---> 19 return codecs.charmap_encode(input,self.errors,encoding_table)[0] 20 21 class IncrementalDecoder(codecs.IncrementalDecoder):

UnicodeEncodeError: 'charmap' codec can't encode characters in position 678150-678153: character maps to """

I was very excited about the following README code:

def _generate_program_list(language: LanguageCollection) -> MDList:
    """
    A helper function which generates a list of programs for the README.
    :param language: a language collection
    :return: a list of sample programs list items
    """
    list_items = list()
    for program in language.sample_programs:
        readable_name = program.normalized_name.replace("-", " ").title()
        program_name = f"{readable_name} in {language.get_readable_name()}"
        program_line = Paragraph([f":white_check_mark: {program_name} [Requirements]"]) \
            .insert_link(f"{readable_name} in {language.get_readable_name()}", program.sample_program_doc_url) \
            .insert_link("Requirements", program.sample_program_req_url)
        if not program_line.verify_urls()[program.sample_program_doc_url]:
            program_line.replace(":white_check_mark:", ":warning:")
            program_line.insert_link(program_name, program.sample_program_issue_url)
        list_items.append(program_line)
    return MDList(list_items)

The only problem is it doesn't work. The second time we call insert link, it doesn't actually replace the link. I'm not really sure how this should work at the moment, but as it stands, this doesn't work.

We ran into this issue with punctuation (#18), and I'm realizing that this issue is bigger than I thought. I'm not sure how to solve this at the moment, but something to think about for sure. The particular issue that I'm noticing is that we can't even embed links in the middle of structures. For example, I can't do this with SnakeMD:

[[Link](https://test.com)]

This will render with spaces on either end as follows:

[ [Link](https://test.com) ]

This turned out to be the same issue we were having with punctuation, and I already didn't like the regex then.

When I exposed Verify Link in 0.2.0, I figured that would make life easier, but it introduces a new problem. The text of the InlineText object needs to be set before the URL can be tested. This isn't a problem necessarily, but if the text is dependent on the URL existing, then you'll have to create a separate InlineText object (or update the existing one).

I'm not sure there is anything to rework here as there may just need to be a pattern defined when this types of situations arise.

I need to write hundreds of rows to markdown, and want to write the header, then run an async function to get some output and then send write rows to markdown.

Currently, I need to create an array to include all the rows, then write everything to the list.

It would be good to have a way to write a table, e.g.:

doc.write_table_header(...)
for row in long_running_iterator():
    doc.write_table_row(...)

My initial thought was to have small chunks of markdown stored in files that could be injected into an existing doc. I still like this idea but it may involve parsing. A shortcut would be to let people input raw markdown and just not check it for them. Their risk.

Right now, paragraphs are rendered on a single line. One thing I'd love for this library to do would be to have some support for pretty printing the documents. At the very least, it would be nice to render the text with line length limits.

One feature I'd like to see is an option to use the reference structure for URLs. Here's an example where I think that would be really nice:

The following table contains all the existing languages in the repository that start with the letter A:

| Language                                                                         | Article(s)                                                             | Issue(s)                                                                                           | Test(s)                                                                        | # of Snippets |
| -------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------- |
| [Abap](/TheRenegadeCoder/sample-programs/tree/main/archive/a/abap)               |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+abap)        |                                                                                | 1             |
| [Ada](/TheRenegadeCoder/sample-programs/tree/main/archive/a/ada)                 |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+ada)         | [Here](/TheRenegadeCoder/sample-programs/tree/main/archive/a/ada/testinfo.yml) | 1             |
| [Agda](/TheRenegadeCoder/sample-programs/tree/main/archive/a/agda)               |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+agda)        |                                                                                | 1             |
| [Algol68](/TheRenegadeCoder/sample-programs/tree/main/archive/a/algol68)         | [Here](https://sample-programs.therenegadecoder.com/languages/algol68) | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+algol68)     |                                                                                | 1             |
| [Apex](/TheRenegadeCoder/sample-programs/tree/main/archive/a/apex)               |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+apex)        |                                                                                | 2             |
| [Applescript](/TheRenegadeCoder/sample-programs/tree/main/archive/a/applescript) |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+applescript) |                                                                                | 1             |
| [Arkscript](/TheRenegadeCoder/sample-programs/tree/main/archive/a/arkscript)     |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+arkscript)   |                                                                                | 1             |
| [Astro](/TheRenegadeCoder/sample-programs/tree/main/archive/a/astro)             |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+astro)       |                                                                                | 1             |
| [Autohotkey](/TheRenegadeCoder/sample-programs/tree/main/archive/a/autohotkey)   |                                                                        | [Here](/TheRenegadeCoder/sample-programs/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+autohotkey)  |                                                                                | 1             |
| **Totals**                                                                       |                                                                        |                                                                                                    |                                                                                | 10            |

< [Previous (Z)](/TheRenegadeCoder/sample-programs/wiki/Z) | [Next (B)](/TheRenegadeCoder/sample-programs/wiki/B) >

This table is absurd. We could simplify it dramatically by converting these long links to numbers.

With the addition of replace, I suspect that many InlineText objects are going to be generated in Paragraphs. I don't know that it matters, but I think it's a bit easier to make sense of the underlying structure if text-only elements are aggregated.