search

gkz / LiveScript

LiveScript is a language which compiles to JavaScript. It has a straightforward mapping to JavaScript and allows you to write expressive code devoid of repetitive boilerplate. While LiveScript adds many features to assist in functional style programming, it also has many improvements for object oriented and imperative programming.
http://livescript.net
MIT License
2.31k stars 155 forks source link

Add anchors to headers in LiveScript docs #734

Open raine opened 9 years ago

raine commented 9 years ago

It would be great if you could link to h3's on http://livescript.net

vendethiel commented 9 years ago

Definitely! :+1:

dead-claudia commented 9 years ago

@raine Here's an idea: make a PR. The site is in the gh-pages branch.

phanimahesh commented 9 years ago

Is there a separate source from which it is built, or do we have to edit raw html?

gkz commented 9 years ago

raw html

phanimahesh commented 9 years ago

Both the styles: <a name="anchor"></a> and <h3 id="anchor"> are being used on the page currently. @gkz: Do you have any preference, and if yes, should I clean up to have consistency?

How do we display something in the UI from where users can "get" the anchors? May be a tiny link icon next to h3s and other anchors on hover? Including everything in the navigation may be an overkill.

Also, isn't writing, editing and maintaining raw html a little tedious and error-prone? IMO, atleast the index should be autogenerated, and/or a pseudo-test to detect mistakes like adding links without corresponding targets, CSS rules that match no items, etc should be included. Would a PR be acceptable along those lines?

raine commented 9 years ago

How do we display something in the UI from where users can "get" the anchors?

Github style link icons on hover would work great.

phanimahesh commented 9 years ago

That was what I was suggesting. Will try that out for now, and we can choose whichever one looks best from all proposed alternates.