mirrors
/
devdocs
mirror of https://github.com/freeCodeCamp/devdocs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HTTPS links

Browse Source
pull/370/head
Kornel Lesiński 9 years ago committed by Kornel Lesiński
parent f9507b87de
commit c744b07726
10 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File

4
README.md
Unescape View File

@ -1,4 +1,4 @@
# [DevDocs](http://devdocs.io) [![Build Status](https://travis-ci.org/Thibaut/devdocs.svg?branch=master)](https://travis-ci.org/Thibaut/devdocs) # [DevDocs](https://devdocs.io) [![Build Status](https://travis-ci.org/Thibaut/devdocs.svg?branch=master)](https://travis-ci.org/Thibaut/devdocs)
DevDocs combines multiple API documentations in a fast, organized, and searchable interface. DevDocs combines multiple API documentations in a fast, organized, and searchable interface.
@ -17,7 +17,7 @@ DevDocs is free and open source. If you like it, please consider supporting my w
## Quick Start ## Quick Start
Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](http://devdocs.io). It's up-to-date and works offline out-of-the-box. Unless you wish to contribute to the project, I recommend using the hosted version at [devdocs.io](https://devdocs.io). It's up-to-date and works offline out-of-the-box.
DevDocs is made of two separate pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app. DevDocs is made of two separate pieces: a Ruby scraper that generates the documentation and metadata, and a JavaScript app powered by a small Sinatra app.

4
assets/javascripts/templates/pages/offline_tmpl.coffee
Unescape View File

@ -41,11 +41,11 @@ app.templates.offlinePage = (docs) -> """
canICloseTheTab = -> canICloseTheTab = ->
if app.AppCache.isEnabled() if app.AppCache.isEnabled()
""" Yes! Even offline, you can open a new tab, go to <a href="http://devdocs.io">devdocs.io</a>, and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """ """ Yes! Even offline, you can open a new tab, go to <a href="https://devdocs.io">devdocs.io</a>, and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """
else if app.mozApp else if app.mozApp
""" Yes! Even offline, you can open the app and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """ """ Yes! Even offline, you can open the app and everything will work as if you were online (provided you installed all the documentations you want to use beforehand). """
else else
""" No. AppCache isn't available in your browser (or is disabled) so loading <a href="http://devdocs.io">devdocs.io</a> offline won't work.<br> """ No. AppCache isn't available in your browser (or is disabled) so loading <a href="https://devdocs.io">devdocs.io</a> offline won't work.<br>
The current tab will continue to work, though (provided you installed all the documentations you want to use beforehand). """ The current tab will continue to work, though (provided you installed all the documentations you want to use beforehand). """
app.templates.offlineDoc = (doc, status) -> app.templates.offlineDoc = (doc, status) ->

2
assets/javascripts/templates/pages/root_tmpl.coffee.erb
Unescape View File

@ -8,7 +8,7 @@ app.templates.intro = """
<p>Thanks for downloading DevDocs. Here are a few things you should know: <p>Thanks for downloading DevDocs. Here are a few things you should know:
<ol class="_intro-list"> <ol class="_intro-list">
<li>Your local version of DevDocs won't self-update. Unless you're modifying the code, <li>Your local version of DevDocs won't self-update. Unless you're modifying the code,
I&nbsp;recommend using the hosted version at <a href="http://devdocs.io">devdocs.io</a>. I&nbsp;recommend using the hosted version at <a href="https://devdocs.io">devdocs.io</a>.
<li>Run <code>thor docs:list</code> to see all available documentations. <li>Run <code>thor docs:list</code> to see all available documentations.
<li>Run <code>thor docs:download &lt;name&gt;</code> to download documentations. <li>Run <code>thor docs:download &lt;name&gt;</code> to download documentations.
<li>Run <code>thor docs:download --installed</code> to update all downloaded documentations. <li>Run <code>thor docs:download --installed</code> to update all downloaded documentations.

16
lib/app.rb
Unescape View File

@ -204,7 +204,7 @@ class App < Sinatra::Application
before do before do
if request.host == OUT_HOST && !request.path.start_with?('/s/') if request.host == OUT_HOST && !request.path.start_with?('/s/')
query_string = "?#{request.query_string}" unless request.query_string.empty? query_string = "?#{request.query_string}" unless request.query_string.empty?
redirect "http://devdocs.io#{request.path}#{query_string}", 302 redirect "https://devdocs.io#{request.path}#{query_string}", 302
end end
end end
@ -254,9 +254,9 @@ class App < Sinatra::Application
'/s/jetbrains/c' => 'https://www.jetbrains.com/clion/?utm_source=devdocs&utm_medium=sponsorship&utm_campaign=devdocs', '/s/jetbrains/c' => 'https://www.jetbrains.com/clion/?utm_source=devdocs&utm_medium=sponsorship&utm_campaign=devdocs',
'/s/jetbrains/web' => 'https://www.jetbrains.com/webstorm/?utm_source=devdocs&utm_medium=sponsorship&utm_campaign=devdocs', '/s/jetbrains/web' => 'https://www.jetbrains.com/webstorm/?utm_source=devdocs&utm_medium=sponsorship&utm_campaign=devdocs',
'/s/code-school' => 'http://www.codeschool.com/?utm_campaign=devdocs&utm_content=homepage&utm_source=devdocs&utm_medium=sponsorship', '/s/code-school' => 'http://www.codeschool.com/?utm_campaign=devdocs&utm_content=homepage&utm_source=devdocs&utm_medium=sponsorship',
'/s/tw' => 'https://twitter.com/intent/tweet?url=http%3A%2F%2Fdevdocs.io&via=DevDocs&text=All-in-one%2C%20offline%20API%20documentation%20browser%3A', '/s/tw' => 'https://twitter.com/intent/tweet?url=https%3A%2F%2Fdevdocs.io&via=DevDocs&text=All-in-one%2C%20offline%20API%20documentation%20browser%3A',
'/s/fb' => 'https://www.facebook.com/sharer/sharer.php?u=http%3A%2F%2Fdevdocs.io', '/s/fb' => 'https://www.facebook.com/sharer/sharer.php?u=https%3A%2F%2Fdevdocs.io',
'/s/re' => 'http://www.reddit.com/submit?url=http%3A%2F%2Fdevdocs.io&title=All-in-one%2C%20offline%20API%20documentation%20browser&resubmit=true' '/s/re' => 'http://www.reddit.com/submit?url=https%3A%2F%2Fdevdocs.io&title=All-in-one%2C%20offline%20API%20documentation%20browser&resubmit=true'
}.each do |path, url| }.each do |path, url|
class_eval <<-CODE, __FILE__, __LINE__ + 1 class_eval <<-CODE, __FILE__, __LINE__ + 1
get '#{path}' do get '#{path}' do
@ -303,13 +303,13 @@ class App < Sinatra::Application
maker.channel.links.new_link do |link| maker.channel.links.new_link do |link|
link.rel = 'self' link.rel = 'self'
link.href = 'http://devdocs.io/feed.atom' link.href = 'https://devdocs.io/feed.atom'
link.type = 'application/atom+xml' link.type = 'application/atom+xml'
end end
maker.channel.links.new_link do |link| maker.channel.links.new_link do |link|
link.rel = 'alternate' link.rel = 'alternate'
link.href = 'http://devdocs.io/' link.href = 'https://devdocs.io/'
link.type = 'text/html' link.type = 'text/html'
end end
@ -318,14 +318,14 @@ class App < Sinatra::Application
item.id = "tag:devdocs.io,2014:News/#{settings.news.length - i}" item.id = "tag:devdocs.io,2014:News/#{settings.news.length - i}"
item.title = news[1].split("\n").first.gsub(/<\/?[^>]*>/, '') item.title = news[1].split("\n").first.gsub(/<\/?[^>]*>/, '')
item.description do |desc| item.description do |desc|
desc.content = news[1..-1].join.gsub("\n", '<br>').gsub('href="/', 'href="http://devdocs.io/') desc.content = news[1..-1].join.gsub("\n", '<br>').gsub('href="/', 'href="https://devdocs.io/')
desc.type = 'html' desc.type = 'html'
end end
item.updated = "#{news.first}T14:00:00Z" item.updated = "#{news.first}T14:00:00Z"
item.published = "#{news.first}T14:00:00Z" item.published = "#{news.first}T14:00:00Z"
item.links.new_link do |link| item.links.new_link do |link|
link.rel = 'alternate' link.rel = 'alternate'
link.href = 'http://devdocs.io/' link.href = 'https://devdocs.io/'
link.type = 'text/html' link.type = 'text/html'
end end
end end

2
public/404.html
Unescape View File

@ -62,7 +62,7 @@
<h1>Oops!</h1> <h1>Oops!</h1>
<p> <p>
<strong>The page you were looking for doesn't exist.</strong><br> <strong>The page you were looking for doesn't exist.</strong><br>
Go back to <a href="http://devdocs.io">devdocs.io</a>. Go back to <a href="https://devdocs.io">devdocs.io</a>.
</p> </p>
</div> </div>
</body> </body>

2
public/500.html
Unescape View File

@ -63,7 +63,7 @@
<p> <p>
<strong>Something is technically wrong.</strong><br> <strong>Something is technically wrong.</strong><br>
Thanks for noticing&mdash;we're going to fix it up and have things back to normal soon.<br> Thanks for noticing&mdash;we're going to fix it up and have things back to normal soon.<br>
Go back to <a href="http://devdocs.io">devdocs.io</a>. Go back to <a href="https://devdocs.io">devdocs.io</a>.
</p> </p>
</div> </div>
</body> </body>

2
public/manifest.webapp
Unescape View File

@ -5,7 +5,7 @@
"developer": { "developer": {
"name": "Thibaut Courouble", "name": "Thibaut Courouble",
"url": "http://devdocs.io" "url": "https://devdocs.io"
}, },
"default_locale": "en", "default_locale": "en",

6
public/opensearch.xml
Unescape View File

@ -3,10 +3,10 @@
<ShortName>DevDocs</ShortName> <ShortName>DevDocs</ShortName>
<Description>Search API documentation</Description> <Description>Search API documentation</Description>
<Tags>devdocs</Tags> <Tags>devdocs</Tags>
<Url type="text/html" method="get" template="http://devdocs.io/#q={searchTerms}"/> <Url type="text/html" method="get" template="https://devdocs.io/#q={searchTerms}"/>
<Image height="16" width="16" type="image/vnd.microsoft.icon">http://cdn.devdocs.io/favicon.ico</Image> <Image height="16" width="16" type="image/vnd.microsoft.icon">http://cdn.devdocs.io/favicon.ico</Image>
<Image height="64" width="64" type="image/x-icon">http://cdn.devdocs.io/images/icon-64.png</Image> <Image height="64" width="64" type="image/x-icon">http://cdn.devdocs.io/images/icon-64.png</Image>
<InputEncoding>UTF-8</InputEncoding> <InputEncoding>UTF-8</InputEncoding>
<moz:SearchForm>http://devdocs.io</moz:SearchForm> <moz:SearchForm>https://devdocs.io</moz:SearchForm>
<Url type="application/opensearchdescription+xml" rel="self" template="http://devdocs.io/opensearch.xml"/> <Url type="application/opensearchdescription+xml" rel="self" template="https://devdocs.io/opensearch.xml"/>
</OpenSearchDescription> </OpenSearchDescription>

6
views/index.erb
Unescape View File

@ -7,16 +7,16 @@
<meta property="og:title" content="DevDocs"> <meta property="og:title" content="DevDocs">
<meta property="og:description" content="DevDocs is an API documentation browser that combines 60+ docs in a single UI with offline mode, instant search, keyboard shortcuts, and more."> <meta property="og:description" content="DevDocs is an API documentation browser that combines 60+ docs in a single UI with offline mode, instant search, keyboard shortcuts, and more.">
<meta property="og:type" content="website"> <meta property="og:type" content="website">
<meta property="og:url" content="http://devdocs.io"> <meta property="og:url" content="https://devdocs.io">
<meta property="og:image" content="http://cdn.devdocs.io/images/icon-128.png"> <meta property="og:image" content="http://cdn.devdocs.io/images/icon-128.png">
<meta name="apple-mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-status-bar-style" content="black"> <meta name="apple-mobile-web-app-status-bar-style" content="black">
<meta name="format-detection" content="telephone=no"> <meta name="format-detection" content="telephone=no">
<meta name="robots" content="noodp"> <meta name="robots" content="noodp">
<title>DevDocs API Documentation</title> <title>DevDocs API Documentation</title>
<link rel="canonical" href="http://devdocs.io"> <link rel="canonical" href="https://devdocs.io">
<link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="DevDocs Search"> <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="DevDocs Search">
<link rel="alternate" href="http://devdocs.io/feed" title="DevDocs" type="application/atom+xml"> <link rel="alternate" href="https://devdocs.io/feed" title="DevDocs" type="application/atom+xml">
<link rel="icon" type="image/x-icon" href="//cdn.devdocs.io/favicon.ico"> <link rel="icon" type="image/x-icon" href="//cdn.devdocs.io/favicon.ico">
<link rel="fluid-icon" href="http://cdn.devdocs.io/images/fluid-icon.png" title="DevDocs"> <link rel="fluid-icon" href="http://cdn.devdocs.io/images/fluid-icon.png" title="DevDocs">
<link rel="apple-touch-icon" sizes="72x72" href="http://cdn.devdocs.io/images/apple-icon-72.png"> <link rel="apple-touch-icon" sizes="72x72" href="http://cdn.devdocs.io/images/apple-icon-72.png">

2
views/other.erb
Unescape View File

@ -7,7 +7,7 @@
<meta name="format-detection" content="telephone=no"> <meta name="format-detection" content="telephone=no">
<meta property="og:image" content="http://cdn.devdocs.io/images/icon-128.png"> <meta property="og:image" content="http://cdn.devdocs.io/images/icon-128.png">
<title>DevDocs<%= " - #{@doc['full_name']} documentation" if doc_index_page? %></title> <title>DevDocs<%= " - #{@doc['full_name']} documentation" if doc_index_page? %></title>
<link rel="canonical" href="http://devdocs.io<%= request.path %>"> <link rel="canonical" href="https://devdocs.io<%= request.path %>">
<link rel="icon" type="image/x-icon" href="//cdn.devdocs.io/favicon.ico"> <link rel="icon" type="image/x-icon" href="//cdn.devdocs.io/favicon.ico">
<link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Search DevDocs"> <link rel="search" type="application/opensearchdescription+xml" href="/opensearch.xml" title="Search DevDocs">
<link rel="stylesheet" href="<%= main_stylesheet_path %>" data-alt="<%= alternate_stylesheet_path %>"> <link rel="stylesheet" href="<%= main_stylesheet_path %>" data-alt="<%= alternate_stylesheet_path %>">

Write Preview
Loading…
Cancel
Save