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

Fix error when make outline summary. #28

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Haitham-AbdelKarim
Copy link

In the outline function, we iterate through each header and its paragraph. In each iteration, we pass this paragraph to functions that remove images, links, etc. But those functions accept the path of the README.md file, so the error "Invalid file. Only Markdown files (.md) are supported." raised.

To solve this problem, I changed the input parameter to accept the markdown content as a string and removed the reading file code from the implementation. I also checked if those functions are used in another place to avoid conflict and found that they are used only in the outline function.

Each function reads the file from given path. However, if we want to remove images, links, etc. from one README.md file, we need after each function call to write the output to the file again to be able to use the other functions, and it doesn't make sense.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant