mirror of https://github.com/freeCodeCamp/devdocs
parent
884f21e1a9
commit
abbd43b85e
@ -0,0 +1,25 @@
|
|||||||
|
._jsdoc {
|
||||||
|
> h2 { @extend %block-heading; }
|
||||||
|
|
||||||
|
> h3 {
|
||||||
|
@extend %lined-heading;
|
||||||
|
font-size: 1.1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
figure {
|
||||||
|
margin-left: 0;
|
||||||
|
font-size: inherit;
|
||||||
|
|
||||||
|
pre {
|
||||||
|
margin-bottom: 0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
figcaption {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pre {
|
||||||
|
font-size: inherit;
|
||||||
|
}
|
||||||
|
}
|
@ -0,0 +1,43 @@
|
|||||||
|
module Docs
|
||||||
|
class Jsdoc
|
||||||
|
class CleanHtmlFilter < Filter
|
||||||
|
def call
|
||||||
|
css('h2').each do |node|
|
||||||
|
next unless node.content.strip == 'Table of Contents'
|
||||||
|
toc_ul = node.next_element
|
||||||
|
toc_block = node.add_next_sibling('<nav class="_toc" role="directory"></nav>').first
|
||||||
|
|
||||||
|
node.name = 'h3'
|
||||||
|
node['class'] = '_toc-title'
|
||||||
|
node.remove
|
||||||
|
toc_block.add_child(node)
|
||||||
|
|
||||||
|
toc_ul.remove
|
||||||
|
toc_ul['class'] = '_toc-list'
|
||||||
|
toc_ul.css('ul').each do |child_list|
|
||||||
|
child_list.remove
|
||||||
|
end
|
||||||
|
toc_block.add_child(toc_ul)
|
||||||
|
end
|
||||||
|
|
||||||
|
css('.prettyprint').each do |node|
|
||||||
|
match = /lang-(\w+)/.match(node['class'])
|
||||||
|
next unless match
|
||||||
|
|
||||||
|
lang = match[1]
|
||||||
|
node.remove_attribute('class')
|
||||||
|
node['data-language'] = lang
|
||||||
|
end
|
||||||
|
|
||||||
|
css('figure').each do |node|
|
||||||
|
caption = node.at_css 'figcaption'
|
||||||
|
next unless caption
|
||||||
|
|
||||||
|
node.children.last.add_next_sibling(caption)
|
||||||
|
end
|
||||||
|
|
||||||
|
doc
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
@ -0,0 +1,25 @@
|
|||||||
|
module Docs
|
||||||
|
class Jsdoc
|
||||||
|
class EntriesFilter < Docs::EntriesFilter
|
||||||
|
def get_name
|
||||||
|
at_css('h1').content
|
||||||
|
end
|
||||||
|
def get_type
|
||||||
|
case slug
|
||||||
|
when /^about-/
|
||||||
|
'Getting Started'
|
||||||
|
when /^plugins-/
|
||||||
|
'Plugins'
|
||||||
|
when /^howto-/
|
||||||
|
'Examples'
|
||||||
|
when /^tags-inline-/
|
||||||
|
'Inline Tags'
|
||||||
|
when /^tags-/
|
||||||
|
'Tags'
|
||||||
|
else
|
||||||
|
'Other' # Only shown if a new category gets added in the upstream docs
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
@ -0,0 +1,30 @@
|
|||||||
|
module Docs
|
||||||
|
class Jsdoc < UrlScraper
|
||||||
|
self.name = 'JSDoc'
|
||||||
|
self.type = 'jsdoc'
|
||||||
|
self.release = '3.5.5'
|
||||||
|
self.base_url = 'http://usejsdoc.org/'
|
||||||
|
self.links = {
|
||||||
|
home: 'http://usejsdoc.org/',
|
||||||
|
code: 'https://github.com/jsdoc3/jsdoc'
|
||||||
|
}
|
||||||
|
|
||||||
|
html_filters.push 'jsdoc/clean_html', 'jsdoc/entries'
|
||||||
|
|
||||||
|
options[:trailing_slash] = false
|
||||||
|
options[:container] = 'article'
|
||||||
|
options[:skip] = [
|
||||||
|
'about-license-jsdoc3.html'
|
||||||
|
]
|
||||||
|
options[:attribution] = <<-HTML
|
||||||
|
© 2011–2017
|
||||||
|
<a href="https://github.com/jsdoc3/jsdoc3.github.com/contributors">
|
||||||
|
JSDoc 3 contributors
|
||||||
|
</a><br>
|
||||||
|
Licensed under
|
||||||
|
<a href="http://creativecommons.org/licenses/by-sa/3.0/">
|
||||||
|
CC BY-SA 3.0
|
||||||
|
</a>
|
||||||
|
HTML
|
||||||
|
end
|
||||||
|
end
|
After Width: | Height: | Size: 246 B |
After Width: | Height: | Size: 529 B |
@ -0,0 +1 @@
|
|||||||
|
https://avatars2.githubusercontent.com/u/1530630
|
Loading…
Reference in new issue