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

Instructions? #32

Open
Whip opened this issue Oct 28, 2015 · 11 comments
Open

Instructions? #32

Whip opened this issue Oct 28, 2015 · 11 comments

Comments

@Whip
Copy link

Whip commented Oct 28, 2015

Could you be bothered to write some instructions on how to use this please?

Thanks

@wentin
Copy link
Owner

wentin commented Oct 28, 2015

Will do, I need to fix a few bugs before it is publicly used. Otherwise it could be a nightmare! Stay tuned!

@tomByrer
Copy link

tomByrer commented Jan 2, 2016

Looking forward to your improvements.

@oyeanuj
Copy link

oyeanuj commented Jan 6, 2016

+1 to this, looking forward to the instructions to try it out! Thanks @wentin for your work on this!

@fabiocaccamo
Copy link

+1

1 similar comment
@tbredin
Copy link

tbredin commented Jun 6, 2016

+1

@Fastidious
Copy link

Interested as well. Any updates?

@TeMuNiDe
Copy link

TeMuNiDe commented Jun 8, 2017

+1

1 similar comment
@zr87
Copy link

zr87 commented Oct 4, 2017

+1

@jdmdigital
Copy link

We didn't develop Underline.js, but here's a quick & dirty explanation on how we got this to work.

Include Underline.js in your project. The code is: https://github.com/CloudflareApps/SmartUnderline/blob/master/js/smart-underline.js

We minified that in our project, but whatever.

Once that was included we just initialize it like so:

$( document ).ready(function() { SmartUnderline.init({}); });

That turns it on with no options. There are plenty, but we liked it just the way it is.

Hope that helps. Let us know if you need some more direction and we'll put something together and post a link here to a more in-depth instructional article.

@oyeanuj
Copy link

oyeanuj commented Oct 18, 2017

@jdmdigital Thank you for the explanation! I'd appreciate any links with more in-depth instructions whenever you get to that. Until then, quick question - how does SmartUnderline differ from Underline.js?

@jdmdigital
Copy link

@oyeanuj, Totally got that wrong. UnderlineJS is self-initializing. What we posted above is how to initialize SmartUnderline--which is what we chose to use in our project. Oops!

Posted something about the two JS libraries, how they work, and what the differences are. Take a look here: https://jdmdigital.co/news/design/skip-descenders-javascript/

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

10 participants