search

rustwasm / wasm-pack

📦✨ your favorite rust -> wasm workflow tool!
https://rustwasm.github.io/wasm-pack/
Apache License 2.0
6.15k stars 403 forks source link

README.rst is not recognized as valid #669

Open Warfields opened 5 years ago

Warfields commented 5 years ago

🐛 Bug description

wasm-pack does not recognize README.rst

🤔 Expected Behavior

The readme should be recognized as being there.

👟 Steps to reproduce

create a readme.rst

🌍 Your environment

Include the relevant details of your environment. wasm-pack version: 0.8.1 rustc version: 1.35.0 (3c235d560 2019-05-20)

Warfields commented 5 years ago

421

ashleygwilliams commented 5 years ago

hey! we currently do not support rst because the readme functionality is focused on publishing to the npm registry which does not recognize rst readme extensions. https://docs.npmjs.com/about-package-readme-files

can you explain your use case for using .rst extension READMEs?

Warfields commented 5 years ago

hey! we currently do not support rst because the readme functionality is focused on publishing to the npm registry which does not recognize rst readme extensions. https://docs.npmjs.com/about-package-readme-files

can you explain your use case for using .rst extension READMEs?

Gotcha, I program a lot in Python where Restructured Text is used for documentation. I also use Sphinx Docs for most of my static sites, which also uses Restructured Text. I just know it a lot better than mark down, github supports Restructured Text for readmes, and use it has a lot of utilities to convert it to other forms (rst2html, rst2beamer, rst2pdf, etc) . If it's a npm problem then I can see this as not fixable here.

ashleygwilliams commented 4 years ago

@Warfields sorry for the extremely delayed response. do you use wasm-pack to publish to npm? if not... would it be helpful to still move the readme, but perhaps warn that it will not be publishable to npm? let me know!