aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFelix Mulder <felix.mulder@gmail.com>2016-10-06 18:30:28 +0200
committerFelix Mulder <felix.mulder@gmail.com>2016-10-06 18:30:28 +0200
commit8c54c8fce1629b4d23c25f24060e00759f0f850b (patch)
treec684582ee4626d4f83c1df0374dc2bcdcf62e5a6 /docs
parent10ff9494165210b22eb80e989fc10c3ebf393bae (diff)
downloaddotty-8c54c8fce1629b4d23c25f24060e00759f0f850b.tar.gz
dotty-8c54c8fce1629b4d23c25f24060e00759f0f850b.tar.bz2
dotty-8c54c8fce1629b4d23c25f24060e00759f0f850b.zip
Remove relative links for markdown plugin
This plugin caused the Github site builder to kill the build (github has a limited number of trusted plugins - this wasn't one of them).
Diffstat (limited to 'docs')
-rw-r--r--docs/_config.yml1
-rw-r--r--docs/_layouts/default.html10
-rw-r--r--docs/_plugins/JekyllMarkdownLinkConverter/LICENSE202
-rw-r--r--docs/_plugins/JekyllMarkdownLinkConverter/converter.rb66
4 files changed, 9 insertions, 270 deletions
diff --git a/docs/_config.yml b/docs/_config.yml
index 1460cbaac..290e9b4d1 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -1,6 +1,5 @@
title: Dotty Documentation
baseurl: "/"
-markdown: JekyllMarkdownLinkConverter
theme: minima
gems:
- jekyll-toc
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
index 19cd7ce59..d55fb4dfa 100644
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@@ -19,5 +19,13 @@
</div>
</body>
<script src="/js/highlight.pack.js"></script>
- <script>hljs.initHighlightingOnLoad();</script>
+ <script language="javascript">
+ hljs.initHighlightingOnLoad();
+ var x = document.links.length;
+ for (i = 0; i < x; i++) {
+ var thisHREF = document.links[i].href;
+ if (thisHREF.indexOf(window.location.hostname) > -1) thisHREF = thisHREF.replace(".md","/").replace("/index/","/");
+ document.links[i].setAttribute('href', thisHREF);
+ }
+ </script>
</html>
diff --git a/docs/_plugins/JekyllMarkdownLinkConverter/LICENSE b/docs/_plugins/JekyllMarkdownLinkConverter/LICENSE
deleted file mode 100644
index 8f71f43fe..000000000
--- a/docs/_plugins/JekyllMarkdownLinkConverter/LICENSE
+++ /dev/null
@@ -1,202 +0,0 @@
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "{}"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright {yyyy} {name of copyright owner}
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
diff --git a/docs/_plugins/JekyllMarkdownLinkConverter/converter.rb b/docs/_plugins/JekyllMarkdownLinkConverter/converter.rb
deleted file mode 100644
index 95b8f1fb4..000000000
--- a/docs/_plugins/JekyllMarkdownLinkConverter/converter.rb
+++ /dev/null
@@ -1,66 +0,0 @@
-# We need to be placed in Kramdown::Converter.
-# When calling a method on a Kramdown document of the form "to_****",
-# Kramdown will shave off the "****" portion, Pascal-case it, and
-# look for a class of that name in Kramdown::Converter.
-# See https://github.com/gettalong/kramdown/blob/05d467bfb9abb732046e441ef1958471195d665d/lib/kramdown/document.rb#L113-L116
-module Kramdown
- module Converter
- # Fixes relative markdown links to point to their dash-separated, lowercased html outputs
- class MarkdownLinkAmendedHtml < Html
- def convert_a(el, indent)
- href = el.attr['href']
- # Ensure that the link is relative to the site (doesn't start with "protocol://")
- # and that it links to a markdown file.
- if not /^\w+?:\/\// =~ href and href.end_with?('.md')
- # Duplicate the attributes to avoid modifying the tree.
- attr = el.attr.dup
-
- # Remove the 'md', replace whitespace with dashes, switch the extension to html
- dir, md_base = File.split(href)
- html_base = md_base.chomp('.md').gsub(/\s+|\.|'/, '-').downcase + '.html'
- attr['href'] = File.join(dir, html_base)
-
- self.format_as_span_html(el.type, attr, self.inner(el, indent))
- else
- super(el, indent)
- end
- end
- end
- end
-end
-
-# One requirement for Jekyll not to freak out
-# is that we need to be in the Jekyll::Converters::Markdown
-# module to be a valid markdown converter.
-module Jekyll
- class Converters::Markdown::JekyllMarkdownLinkConverter < Converter
- safe true
-
- # Match markdown files.
- def matches(ext)
- ext =~ /^\.md$/i
- end
-
- # Output html files.
- def output_ext(ext)
- '.html'
- end
-
- def convert(content)
- kramdown_config = symbolize_keys(@config['kramdown'])
- doc = Kramdown::Document.new(content, kramdown_config)
- html = doc.to_markdown_link_amended_html
- return html;
- end
- end
-end
-
-def symbolize_keys(input)
- result = {}
-
- input.each do |k,v|
- result[k.intern] = v
- end
-
- result
-end \ No newline at end of file