wpreadme2markdown / wp-readme-to-markdown

Convert WordPress Plugin Readme Files to GitHub Flavored Markdown
MIT License
92 stars 20 forks source link

You do not explain how to use it #19

Closed onigetoc closed 8 years ago

onigetoc commented 8 years ago

I check the code but i don't understand how to use it

sunchaserinfo commented 8 years ago

please explain your use case

onigetoc commented 8 years ago

I want to create a form to paste or load remotetly a readme file that user can enter and get the Github Markdow result in a web page.

sunchaserinfo commented 8 years ago

You should use this (the only public) method of wp2md as it's already stated in our readme

$markdown = \WPReadme2Markdown\Converter::convert($readme);

where $readme is user's readme and $markdown is a markdown code to display

https://github.com/sunchaserinfo/wpreadme2markdown.com/blob/master/src/classes/Controller.php#L36

this part does exactly that

onigetoc commented 8 years ago

Ok, thank you, i will try it.

benbalter commented 8 years ago

@sunchaserinfo do you have any interest in maintaining this project going forward? Nothing new would be required beyond what you're already doing, I'd just transfer the project to your account so that it's under your name. Glad to chat offline more as well.

onigetoc commented 8 years ago

Hi, Please, can you tell me about witch project do you refert to?

2016-01-03 17:11 GMT-05:00 Ben Balter notifications@github.com:

@sunchaserinfo https://github.com/sunchaserinfo do you have any interest in maintaining this project going forward? Nothing new would be required beyond what you're already doing, I'd just transfer the project to your account so that it's under your name. Glad to chat offline more as well http://ben.balter.com/contact/.

— Reply to this email directly or view it on GitHub https://github.com/benbalter/WP-Readme-to-Github-Markdown/issues/19#issuecomment-168544562 .

sunchaserinfo commented 8 years ago

@benbalter i think that's possible and i think it's better to move the project to its own namespace (i think of wp2md/) i'll move wpreadme2markdown.com there as well

onigetoc commented 8 years ago

Hi Christian,

Is this work on a node server?

If yes, i don't really know node.js and and do not have https server.

2016-01-05 8:34 GMT-05:00 Christian Archer notifications@github.com:

@benbalter https://github.com/benbalter i think that's possible and i think it's better to move the project to its own namespace (i think of wp2md/) i'll move wpreadme2markdown.com there as well

— Reply to this email directly or view it on GitHub https://github.com/benbalter/WP-Readme-to-Github-Markdown/issues/19#issuecomment-168998450 .

onigetoc commented 8 years ago

I want to make a javascript version and i find this grunt task who do it.

It will be interesting to convert it to a javascript converter.

https://github.com/stephenharris/wp-readme-to-markdown/blob/master/tasks/wp_readme_to_markdown.js

Project Github page: https://github.com/stephenharris/wp-readme-to-markdown

2016-01-06 0:41 GMT-05:00 Gino Côté ginocote@gmail.com:

Hi Christian,

Is this work on a node server?

If yes, i don't really know node.js and and do not have https server.

2016-01-05 8:34 GMT-05:00 Christian Archer notifications@github.com:

@benbalter https://github.com/benbalter i think that's possible and i think it's better to move the project to its own namespace (i think of wp2md/) i'll move wpreadme2markdown.com there as well

— Reply to this email directly or view it on GitHub https://github.com/benbalter/WP-Readme-to-Github-Markdown/issues/19#issuecomment-168998450 .

sunchaserinfo commented 8 years ago

@onigetoc sorry, can't help with javascript

sunchaserinfo commented 8 years ago

i think it can be closed