mirror of https://github.com/freeCodeCamp/devdocs
Merge pull request #954 from filipesilva/rxjs
Add RxJS Co-authored-by: Jasper van Merle <jaspervmerle@gmail.com>pull/1061/head
Jasper van Merle
6 years ago
committed by
GitHub
commit
79acde09ed
@ -0,0 +1,24 @@
|
||||
._rxjs {
|
||||
@extend %simple;
|
||||
|
||||
.pre-title { @extend %pre-heading; }
|
||||
|
||||
.breadcrumbs { @extend %note; }
|
||||
.banner { @extend %note-green; }
|
||||
code.stable { @extend %label-green; }
|
||||
code.experimental { @extend %label-orange; }
|
||||
code.deprecated { @extend %label-red; }
|
||||
.alert.is-important { @extend %note-red; }
|
||||
.alert.is-helpful, .breadcrumbs { @extend %note-blue; }
|
||||
|
||||
.breadcrumbs { padding-left: 2em; }
|
||||
|
||||
img { margin: 1em 0; }
|
||||
|
||||
.location-badge {
|
||||
font-style: italic;
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
td h3 { margin: 0 !important; }
|
||||
}
|
||||
@ -0,0 +1,139 @@
|
||||
module Docs
|
||||
class Rxjs
|
||||
class CleanHtmlFilter < Filter
|
||||
def call
|
||||
if root_page?
|
||||
css('.card-container').remove
|
||||
at_css('h1').content = 'RxJS Documentation'
|
||||
end
|
||||
|
||||
if at_css('h1').nil?
|
||||
title = subpath.rpartition('/').last.titleize
|
||||
doc.prepend_child("<h1>#{title}</h1>")
|
||||
end
|
||||
|
||||
css('br', 'hr', '.material-icons', '.header-link', '.breadcrumb').remove
|
||||
|
||||
css('.content', 'article', '.api-header', 'section', '.instance-member').each do |node|
|
||||
node.before(node.children).remove
|
||||
end
|
||||
|
||||
css('label', 'h2 > em', 'h3 > em').each do |node|
|
||||
node.name = 'code'
|
||||
end
|
||||
|
||||
css('h1 + code').each do |node|
|
||||
node.before('<p></p>')
|
||||
while node.next_element.name == 'code'
|
||||
node.previous_element << ' '
|
||||
node.previous_element << node.next_element
|
||||
end
|
||||
node.previous_element.prepend_child(node)
|
||||
end
|
||||
|
||||
css('td h3', '.l-sub-section > h3', '.alert h3', '.row-margin > h3', '.api-heading ~ h3', '.api-heading + h2', '.metadata-member h3').each do |node|
|
||||
node.name = 'h4'
|
||||
end
|
||||
|
||||
css('.l-sub-section', '.alert', '.banner').each do |node|
|
||||
node.name = 'blockquote'
|
||||
end
|
||||
|
||||
css('.file').each do |node|
|
||||
node.content = node.content.strip
|
||||
end
|
||||
|
||||
css('.filetree .children').each do |node|
|
||||
node.css('.file').each do |n|
|
||||
n.content = " #{n.content}"
|
||||
end
|
||||
end
|
||||
|
||||
css('.filetree').each do |node|
|
||||
node.content = node.css('.file').map(&:inner_html).join("\n")
|
||||
node.name = 'pre'
|
||||
node.remove_attribute('class')
|
||||
end
|
||||
|
||||
css('pre').each do |node|
|
||||
node.content = node.content.strip
|
||||
|
||||
node['data-language'] = 'typescript' if node['path'].try(:ends_with?, '.ts')
|
||||
node['data-language'] = 'html' if node['path'].try(:ends_with?, '.html')
|
||||
node['data-language'] = 'css' if node['path'].try(:ends_with?, '.css')
|
||||
node['data-language'] = 'js' if node['path'].try(:ends_with?, '.js')
|
||||
node['data-language'] = 'json' if node['path'].try(:ends_with?, '.json')
|
||||
node['data-language'] = node['language'].sub(/\Ats/, 'typescript').strip if node['language']
|
||||
node['data-language'] ||= 'typescript' if node.content.start_with?('@')
|
||||
|
||||
node.before(%(<div class="pre-title">#{node['title']}</div>)) if node['title']
|
||||
|
||||
if node['class'] && node['class'].include?('api-heading')
|
||||
node.name = 'h3'
|
||||
|
||||
unless node.ancestors('.instance-method').empty?
|
||||
matches = node.inner_html.scan(/([^(& ]+)[(&]/)
|
||||
|
||||
unless matches.empty? || matches[0][0] == 'constructor'
|
||||
node['name'] = matches[0][0]
|
||||
node['id'] = node['name'].downcase + '-'
|
||||
end
|
||||
end
|
||||
|
||||
node.inner_html = "<code>#{node.inner_html}</code>"
|
||||
end
|
||||
|
||||
node.remove_attribute('path')
|
||||
node.remove_attribute('region')
|
||||
node.remove_attribute('linenums')
|
||||
node.remove_attribute('title')
|
||||
node.remove_attribute('language')
|
||||
node.remove_attribute('hidecopy')
|
||||
node.remove_attribute('class')
|
||||
end
|
||||
|
||||
css('td > .overloads').each do |node|
|
||||
node.replace node.at_css('.detail-contents')
|
||||
end
|
||||
|
||||
css('td.short-description p').each do |node|
|
||||
signature = node.parent.parent.next_element.at_css('h3[id]')
|
||||
signature.after(node) unless signature.nil?
|
||||
end
|
||||
|
||||
css('.method-table').each do |node|
|
||||
node.replace node.at_css('tbody')
|
||||
end
|
||||
|
||||
css('.api-body > table > caption').each do |node|
|
||||
node.name = 'center'
|
||||
lift_out_of_table node
|
||||
end
|
||||
|
||||
css('.api-body > table > tbody > tr:not([class]) > td > *').each do |node|
|
||||
lift_out_of_table node
|
||||
end
|
||||
|
||||
css('.api-body > table').each do |node|
|
||||
node.remove if node.content.strip.blank?
|
||||
end
|
||||
|
||||
css('h1[class]').remove_attr('class')
|
||||
css('table[class]').remove_attr('class')
|
||||
css('table[width]').remove_attr('width')
|
||||
css('tr[style]').remove_attr('style')
|
||||
|
||||
css('code code').each do |node|
|
||||
node.before(node.children).remove
|
||||
end
|
||||
|
||||
doc
|
||||
end
|
||||
|
||||
def lift_out_of_table(node)
|
||||
table = node.ancestors('table').first
|
||||
table.previous_element.after(node)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,29 @@
|
||||
module Docs
|
||||
class Rxjs
|
||||
class EntriesFilter < Docs::EntriesFilter
|
||||
def get_name
|
||||
title = at_css('h1')
|
||||
name = title.nil? ? subpath.rpartition('/').last.titleize : title.content
|
||||
name.prepend "#{$1}. " if subpath =~ /\-pt(\d+)/
|
||||
name += '()' unless at_css('.api-type-label.function').nil?
|
||||
name
|
||||
end
|
||||
|
||||
def get_type
|
||||
if slug.start_with?('guide')
|
||||
'Guide'
|
||||
elsif slug.start_with?('api/')
|
||||
slug.split('/').second
|
||||
else
|
||||
'Miscellaneous'
|
||||
end
|
||||
end
|
||||
|
||||
def additional_entries
|
||||
css('h3[id]').map do |node|
|
||||
["#{name}.#{node['name']}()", node['id']]
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -0,0 +1,94 @@
|
||||
require 'yajl/json_gem'
|
||||
|
||||
module Docs
|
||||
class Rxjs < UrlScraper
|
||||
self.name = 'RxJS'
|
||||
self.type = 'rxjs'
|
||||
self.release = '6.5.2'
|
||||
self.base_url = 'https://rxjs.dev/'
|
||||
self.root_path = 'guide/overview'
|
||||
self.links = {
|
||||
home: 'https://rxjs.dev/',
|
||||
code: 'https://github.com/ReactiveX/rxjs'
|
||||
}
|
||||
|
||||
html_filters.push 'rxjs/clean_html', 'rxjs/entries'
|
||||
|
||||
options[:follow_links] = false
|
||||
options[:only_patterns] = [/guide\//, /api\//]
|
||||
options[:skip_patterns] = [/api\/([^\/]+)\.json/]
|
||||
options[:fix_urls_before_parse] = ->(url) do
|
||||
url.sub! %r{\Aguide/}, '/guide/'
|
||||
url.sub! %r{\Aapi/}, '/api/'
|
||||
url.sub! %r{\Agenerated/}, '/generated/'
|
||||
url
|
||||
end
|
||||
|
||||
options[:max_image_size] = 256_000
|
||||
|
||||
options[:attribution] = <<-HTML
|
||||
© 2015–2018 Google, Inc., Netflix, Inc., Microsoft Corp. and contributors.<br>
|
||||
Code licensed under an Apache-2.0 License. Documentation licensed under CC BY 4.0.
|
||||
HTML
|
||||
|
||||
def get_latest_version(opts)
|
||||
json = fetch_json('https://rxjs.dev/generated/navigation.json', opts)
|
||||
json['__versionInfo']['raw']
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def initial_urls
|
||||
initial_urls = []
|
||||
|
||||
Request.run "#{self.class.base_url}generated/navigation.json" do |response|
|
||||
data = JSON.parse(response.body)
|
||||
dig = ->(entry) do
|
||||
initial_urls << url_for("generated/docs/#{entry['url']}.json") if entry['url'] && entry['url'] != 'api'
|
||||
entry['children'].each(&dig) if entry['children']
|
||||
end
|
||||
data['SideNav'].each(&dig)
|
||||
end
|
||||
|
||||
Request.run "#{self.class.base_url}generated/docs/api/api-list.json" do |response|
|
||||
data = JSON.parse(response.body)
|
||||
dig = ->(entry) do
|
||||
initial_urls << url_for("generated/docs/#{entry['path']}.json") if entry['path']
|
||||
initial_urls << url_for("generated/docs/api/#{entry['name']}.json") if entry['name'] && !entry['path']
|
||||
entry['items'].each(&dig) if entry['items']
|
||||
end
|
||||
data.each(&dig)
|
||||
end
|
||||
|
||||
initial_urls.select do |url|
|
||||
options[:only_patterns].any? { |pattern| url =~ pattern } &&
|
||||
options[:skip_patterns].none? { |pattern| url =~ pattern }
|
||||
end
|
||||
end
|
||||
|
||||
def handle_response(response)
|
||||
if response.mime_type.include?('json')
|
||||
begin
|
||||
response.options[:response_body] = JSON.parse(response.body)['contents']
|
||||
rescue JSON::ParserError
|
||||
response.options[:response_body] = ''
|
||||
end
|
||||
response.headers['Content-Type'] = 'text/html'
|
||||
response.url.path = response.url.path.sub('/generated/docs/', '/').remove('.json')
|
||||
response.effective_url.path = response.effective_url.path.sub('/generated/docs/', '/').remove('.json')
|
||||
end
|
||||
super
|
||||
end
|
||||
|
||||
def parse(response)
|
||||
response.body.gsub! '<code-example', '<pre'
|
||||
response.body.gsub! '</code-example', '</pre'
|
||||
response.body.gsub! '<code-pane', '<pre'
|
||||
response.body.gsub! '</code-pane', '</pre'
|
||||
response.body.gsub! '<live-example></live-example>', 'live example'
|
||||
response.body.gsub! '<live-example', '<span'
|
||||
response.body.gsub! '</live-example', '</span'
|
||||
super
|
||||
end
|
||||
end
|
||||
end
|
||||
|
After Width: | Height: | Size: 1.5 KiB |
|
After Width: | Height: | Size: 5.0 KiB |
@ -0,0 +1 @@
|
||||
https://github.com/ReactiveX/reactivex.github.io/blob/develop/favicon.ico
|
||||
Loading…
Reference in new issue