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

if tutorials are originally in markdown, they don't get converted #12

Closed
gkatsev opened this issue Jan 4, 2017 · 7 comments
Closed

Comments

@gkatsev
Copy link
Contributor

gkatsev commented Jan 4, 2017

When using this template, if the tutorials are in markdown, they just get copied to the destination directory's tutorials/ folder without conversion.

Also, if tutorials aren't configured as a config option, this template will fail because there's no null check here https://github.com/nhnent/tui.jsdoc-template/blob/master/publish.js#L718.

I'll probably look into this tomorrow, but wanted to post an issue about it first.

@gkatsev
Copy link
Contributor Author

gkatsev commented Jan 4, 2017

This isn't as much of a problem when deployed on github pages now because it'll auto-render markdown now, but means that it looks a bit different than everything else.

@minkyu-yi minkyu-yi modified the milestone: 1.1.0 Jan 4, 2017
@minkyu-yi
Copy link

I missed this problem.
Could you PR to fix it?

Thanks.

@gkatsev
Copy link
Contributor Author

gkatsev commented Jan 6, 2017

I have a fix for the null check.
Still trying to figure out the best way of rendering out the markdown so it looks like other pages, for example, similar to the README.

@gkatsev
Copy link
Contributor Author

gkatsev commented Jan 6, 2017

@minkyu-yi For rendering out the markdown tutorials, what about updating the article in the tutorial.tmpl to either output an iframe for the html page or render out the markdown inline? Then, the styles are easily available for the markdown without any extra work.

@minkyu-yi
Copy link

@gkatsev Fixed in PR #13.
See the PR with demo.

Could you feedback to me? 😊

@gkatsev
Copy link
Contributor Author

gkatsev commented Jan 7, 2017

Sweet! Yeah, I'll take a look in the next couple of days.

@gkatsev
Copy link
Contributor Author

gkatsev commented Jan 9, 2017

Solved via #13 and #14.

@gkatsev gkatsev closed this as completed Jan 10, 2017
gkatsev added a commit to gkatsev/video.js that referenced this issue Jan 23, 2017
Uses the TUI JSDoc template. All configuring of jsdoc was moved to the jsdoc.json file.
There's currently a bug with TUI regarding the tutorials (nhn/tui.jsdoc-template#12) but it should via gh-pages currently because it'll now autorender markdown into html.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants