Add Knockout.js documentation

Thibaut committed 12 years ago

Commit ece6ff81 parent 6b0390d14 files · +121 −-1Browse files

Unified · Split

14 files

Binary file not shown.

Binary file not shown.

@@ -128,6 +128,11 @@ credits = [ · 127 unmodified lines
128	128	'2014 jQuery Foundation',
129	129	'MIT',
130	130	'https://raw.github.com/jquery/api.jqueryui.com/master/LICENSE-MIT.txt'
	131	+ ], [
	132	+ 'Knockout.js',
	133	+ 'Steven Sanderson, the Knockout.js team, and other contributors',
	134	+ 'MIT',
	135	+ 'https://raw.github.com/knockout/knockout/master/LICENSE'
131	136	], [
132	137	'Less',
133	138	'2009-2014 Alexis Sellier & The Core Less Team',

@@ -24,8 +24,8 @@ newsItem = (date, news) -> · 23 unmodified lines
24	24	result
25	25
26	26	app.news = [
27		− [ 1390089600000, # January 19, 2013
28		− """ New <a href="/d3/">D3.js</a> documentation """,
	27	+ [ 1390089600001, # January 19, 2013
	28	+ """ New <a href="/d3/">D3.js</a> and <a href="/knockout/">Knockout.js</a> documentations """,
29	29	], [
30	30	1390003200000, # January 18, 2013
31	31	""" DevDocs is now available as a <a href="https://marketplace.firefox.com/app/devdocs/">Firefox web app</a> (currently requires Aurora). """,

@@ -0,0 +1,8 @@
	1	+#= require views/pages/base
	2	+
	3	+class app.views.KnockoutPage extends app.views.BasePage
	4	+ afterRender: ->
	5	+ for el in @findAll('pre')
	6	+ language = if el.innerHTML.indexOf('data-bind="') > 0 then 'markup' else 'javascript'
	7	+ @highlightCode el, language
	8	+ return

@@ -4,7 +4,7 @@ · 3 unmodified lines
4	4	width: 1rem;
5	5	height: 1rem;
6	6	background-image: image-url('icons.png');
7		− background-size: 5rem 7rem;
	7	+ background-size: 5rem 8rem;
8	8	}
9	9
10	10	@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) {
@@ -46,3 +46,4 @@ · 35 unmodified lines
46	46	._icon-redis:before { background-position: -2rem -6rem; }
47	47	._icon-postgresql:before { background-position: -3rem -6rem; }
48	48	._icon-d3:before { background-position: -4rem -6rem; }
	49	+._icon-knockout:before { background-position: 0 -7rem; }

@@ -0,0 +1,6 @@
	1	+._knockout {
	2	+ > h2 { @extend %block-heading; }
	3	+ > h3 { @extend %block-label, %label-blue; }
	4	+ p > code { @extend %label; }
	5	+ .liveExample { @extend %note; }
	6	+}

@@ -0,0 +1,30 @@
	1	+module Docs
	2	+ class Knockout
	3	+ class CleanHtmlFilter < Filter
	4	+ def call
	5	+ root_page? ? root : other
	6	+
	7	+ css('pre > code').each do \|node\|
	8	+ node.before(node.children).remove
	9	+ end
	10	+
	11	+ doc
	12	+ end
	13	+
	14	+ def root
	15	+ @doc = at_css '.content'
	16	+ at_css('h1').content = 'Knockout.js'
	17	+ end
	18	+
	19	+ def other
	20	+ css('h1 ~ h1').each do \|node\|
	21	+ node.name = 'h2'
	22	+ end
	23	+
	24	+ css('.liveExample').each do \|node\|
	25	+ node.content = 'Live examples are not available on DevDocs, sorry.'
	26	+ end
	27	+ end
	28	+ end
	29	+ end
	30	+end

@@ -0,0 +1,38 @@
	1	+module Docs
	2	+ class Knockout
	3	+ class EntriesFilter < Docs::EntriesFilter
	4	+ NAME_BY_SLUG = {
	5	+ 'custom-bindings' => 'Custom bindings',
	6	+ 'custom-bindings-controlling-descendant-bindings' => 'Descendant bindings',
	7	+ 'custom-bindings-for-virtual-elements' => 'Virtual elements',
	8	+ 'binding-preprocessing' => 'Binding preprocessing',
	9	+ 'json-data' => 'JSON data',
	10	+ 'extenders' => 'Extending observables',
	11	+ 'unobtrusive-event-handling' => 'Event handling',
	12	+ 'fn' => 'Custom functions' }
	13	+
	14	+ def get_name
	15	+ return NAME_BY_SLUG[slug] if NAME_BY_SLUG.has_key?(slug)
	16	+ name = at_css('h1').content.strip
	17	+ name.sub! 'The ', ''
	18	+ name.sub! %r{"(.+?)"}, '\1'
	19	+ name.gsub!(/ [A-Z]/) { \|str\| str.downcase! }
	20	+ name
	21	+ end
	22	+
	23	+ def get_type
	24	+ if name =~ /observable/i \|\| slug =~ /extender/
	25	+ 'Observables'
	26	+ elsif slug.include?('binding') && !name.end_with?('binding')
	27	+ 'Binding'
	28	+ elsif slug.include? 'binding'
	29	+ 'Bindings'
	30	+ elsif slug.include? 'plugin'
	31	+ 'Plugins'
	32	+ else
	33	+ 'Miscellaneous'
	34	+ end
	35	+ end
	36	+ end
	37	+ end
	38	+end

@@ -0,0 +1,32 @@
	1	+module Docs
	2	+ class Knockout < UrlScraper
	3	+ self.name = 'Knockout.js'
	4	+ self.slug = 'knockout'
	5	+ self.type = 'knockout'
	6	+ self.version = '3.0.0'
	7	+ self.base_url = 'http://knockoutjs.com/documentation/'
	8	+ self.root_path = 'introduction.html'
	9	+
	10	+ html_filters.push 'knockout/clean_html', 'knockout/entries'
	11	+
	12	+ options[:follow_links] = ->(filter) { filter.root_page? }
	13	+ options[:container] = ->(filter) { filter.root_page? ? '#wrapper' : '.content' }
	14	+
	15	+ options[:only] = %w(
	16	+ json-data.html
	17	+ extenders.html
	18	+ throttle-extender.html
	19	+ unobtrusive-event-handling.html
	20	+ fn.html)
	21	+
	22	+ options[:only_patterns] = [
	23	+ /observable/i,
	24	+ /binding/,
	25	+ /plugin/]
	26	+
	27	+ options[:attribution] = <<-HTML
	28	+ © Steven Sanderson, the Knockout.js team, and other contributors<br>
	29	+ Licensed under the MIT License.
	30	+ HTML
	31	+ end
	32	+end

Binary file not shown.

Binary file not shown.

@@ -0,0 +1 @@
	1	+http://learn.knockoutjs.com/