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

Documentation doesn't mention markdown-it-py #26

Open
furicle opened this issue Nov 4, 2024 · 0 comments
Open

Documentation doesn't mention markdown-it-py #26

furicle opened this issue Nov 4, 2024 · 0 comments

Comments

@furicle
Copy link

furicle commented Nov 4, 2024

Just trying this for the first time. The documentation seems to make some assumptions that aren't obvious to a new user (me).

1 - Won't work as mentioned on Windows. This wasn't surprising, but perhaps a mention of Windows and requiring python to be installed and on path, and running python.exe manpageblog instead

2 - The one I wasn't expecting - the warning WARNING: Cannot render Markdown in content/blog\2024-06-06-manpageblog-release-1.4.md: No module named 'markdown_it'
If it's not a show stopper (which 'warning' implies), then the docs might tell people it will happen and it's ok to proceed.
If it is a show stopper, we need instructions how to install the module. Note the fact the module isn't called markdown_it is confusing too....

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

No branches or pull requests

1 participant