Skip to content
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.

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

Add Better Docs #3

Open
mantreshkhurana opened this issue Apr 27, 2024 · 0 comments
Open

Add Better Docs #3

mantreshkhurana opened this issue Apr 27, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@mantreshkhurana
Copy link
Owner

Problem:
Markdown checkboxes, indicated by syntax like "- [ ] feature", are not currently supported for parsing within the MarkdownParser class. This limitation restricts the ability to programmatically interact with task lists embedded in Markdown files.

Solution:

  1. Checkbox Parsing:
    • Description: Develop a method to extract checkbox status (checked or unchecked) and associated text from Markdown task list items.
    • Expected Outcome: Users can access structured data representing task list items, including their status (checked or unchecked) and text content.

Alternatives Considered:

  • Manual Parsing: Employ manual parsing techniques using regular expressions or string manipulation to extract checkbox information. However, this approach may be error-prone and labor-intensive.
  • Third-Party Libraries: Utilize third-party Markdown parsing libraries that may offer built-in support for parsing task list items. However, this may introduce dependencies and increase complexity.

Additional Context:
Enhancing the MarkdownParser class with support for parsing Markdown checkboxes would significantly improve its functionality, enabling users to interact with task lists more effectively within Markdown files. This feature would facilitate tasks such as extracting task statuses or modifying task content programmatically.

@mantreshkhurana mantreshkhurana added the enhancement New feature or request label Apr 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant