think about README.md and pypi description

hannob / snallygaster

Tool to scan for secret files on HTTP servers

BSD Zero Clause License

2.07k stars 228 forks source link

think about README.md and pypi description #21

Closed hannob closed 4 years ago

hannob commented 6 years ago

We currently use README.md as the description for the pypi package. However pypi uses rst, which is not the same as markdown, although it partly works.

Possible alternatives:

Convert markdown to rst (with pandoc?)
Do minimal conversion of the links, as the headlines are compatible between rst/md
Use separate description for pypi

delirious-lettuce commented 6 years ago

@hannob

It seems like PyPI has supported markdown for just over a month (the article includes instructions on necessary modifications as well).

https://dustingram.com/articles/2018/03/16/markdown-descriptions-on-pypi

hannob commented 4 years ago

yep, now with markdown description: https://pypi.org/project/snallygaster/ fixed with https://github.com/hannob/snallygaster/commit/a5091dd9463d4e52714ce442037b531481b1a413