History

Update Sequelize documentation (6.23.2)

Simon Legner committed 4 years ago

Commit 73af8771 parent 666d6553 files · +33 −37Browse files

Unified · Split

3 files
  1. lib/docs/filters/sequelize/clean_html.rb +6 −28
  2. lib/docs/filters/sequelize/entries.rb +12 −7
  3. lib/docs/scrapers/sequelize.rb +15 −2
lib/docs/filters/sequelize/clean_html.rb+6−28
@@ -2,26 +2,9 @@ module Docs · 1 unmodified line
2 class Sequelize2 class Sequelize
3 class CleanHtmlFilter < Filter3 class CleanHtmlFilter < Filter
4 def call4 def call
5 @doc = at_css('.content')5 @doc = at_css('article', '.content')
6 6
7 # Clean up the home page7 if at_css('header > h1')
8 if root_page? || subpath == "index.html"
9 # Remove logo
10 css('.manual-user-index > div > div.logo').remove
11
12 # Convert title to proper h1 element
13 at_css('.manual-user-index > div > div.sequelize').name = 'h1'
14
15 # Remove badges (NPM, Travis, test coverage, etc.)
16 css('.manual-user-index > p:nth-child(4)').remove
17
18 # Remove image cards pointing to entries of the manual
19 css('.manual-cards').remove
20
21 # Pull the header out of its container
22 header = at_css('h1')
23 header.parent.parent.parent.add_previous_sibling header
24 else
25 # Pull the header out of its container8 # Pull the header out of its container
26 header = at_css('h1')9 header = at_css('h1')
27 header.parent.add_previous_sibling header10 header.parent.add_previous_sibling header
@@ -36,18 +19,13 @@ module Docs · 8 unmodified lines
36 end19 end
37 20
38 # Add syntax highlighting to code blocks21 # Add syntax highlighting to code blocks
39 css('pre > code[class^="lang-"]').each do |node|22 css('pre[class^="prism-code language-"]').each do |node|
40 pre = node.parent23 node['data-language'] = node['class'][/language-(\w+)/, 1] if node['class'] and node['class'][/language-(\w+)/]
41 # Convert the existing language definitions to Prism-compatible attributes24 node.content = node.css('.token-line').map(&:content).join("\n")
42 pre['data-language'] = 'javascript' if node['class'] == 'lang-js' || node['class'] == 'lang-javascript'
43 pre['data-language'] = 'json' if node['class'] == 'lang-json'
44 pre['data-language'] = 'shell' if node['class'] == 'lang-sh' || node['class'] == 'lang-bash'
45 pre['data-language'] = 'sql' if node['class'] == 'lang-sql'
46 pre['data-language'] = 'typescript' if node['class'] == 'lang-ts'
47 end25 end
48 26
49 # Return the cleaned-up document27 # Return the cleaned-up document
50 doc28 at_css('.markdown') || doc
51 end29 end
52 end30 end
53 end31 end
lib/docs/filters/sequelize/entries.rb+12−7
@@ -8,19 +8,19 @@ module Docs · 7 unmodified lines
8 8
9 # Assign the pages to main categories9 # Assign the pages to main categories
10 def get_type10 def get_type
11 if path.start_with?('manual/')11 if base_url.path.include?('/docs/')
12 'Manual'12 'Manual'
13 elsif path.include?('lib/data-types')13 elsif path.include?('src/data-types')
14 'datatypes'14 'datatypes'
15 elsif path.include?('lib/errors/validation')15 elsif path.include?('src/errors/validation')
16 'errors/validation'16 'errors/validation'
17 elsif path.include?('lib/errors/database')17 elsif path.include?('src/errors/database')
18 'errors/database'18 'errors/database'
19 elsif path.include?('lib/errors/connection')19 elsif path.include?('src/errors/connection')
20 'errors/connection'20 'errors/connection'
21 elsif path.include?('lib/errors')21 elsif path.include?('src/errors')
22 'errors'22 'errors'
23 elsif path.include?('lib/associations')23 elsif path.include?('src/associations')
24 'associations'24 'associations'
25 elsif path.include?('master/variable')25 elsif path.include?('master/variable')
26 'variables'26 'variables'
@@ -28,6 +28,11 @@ module Docs · 1 unmodified line
28 'classes'28 'classes'
29 end29 end
30 end30 end
31
32 def include_default_entry?
33 at_css('.card > h2:contains("📄️")').nil?
34 end
35
31 end36 end
32 end37 end
33end38end
lib/docs/scrapers/sequelize.rb+15−2
@@ -1,5 +1,7 @@
1module Docs1module Docs
2 class Sequelize < UrlScraper2 class Sequelize < UrlScraper
3 include MultipleBaseUrls
4
3 self.name = 'Sequelize'5 self.name = 'Sequelize'
4 self.slug = 'sequelize'6 self.slug = 'sequelize'
5 self.type = 'simple'7 self.type = 'simple'
@@ -20,9 +22,20 @@ module Docs · 14 unmodified lines
20 Licensed under the MIT License.22 Licensed under the MIT License.
21 HTML23 HTML
22 24
25 def initial_urls
26 [
27 "https://sequelize.org/docs/v6/",
28 "https://sequelize.org/api/v6/identifiers.html",
29 ]
30 end
31
23 version '6' do32 version '6' do
24 self.release = '6.5.0'33 self.release = '6.23.2'
25 self.base_url = "https://sequelize.org/master/"34 self.base_url = "https://sequelize.org/docs/v6/"
35 self.base_urls = [
36 "https://sequelize.org/docs/v6/",
37 "https://sequelize.org/api/v6/",
38 ]
26 end39 end
27 40
28 version '5' do41 version '5' do