Move guides to new docs site #2740
Conversation
guides/helpers/image_helpers.rb
Outdated
| ) | ||
| end | ||
| end | ||
| end |
There was a problem hiding this comment.
Layout/TrailingBlankLines: Final newline missing.
guides/helpers/image_helpers.rb
Outdated
| file = File.open(asset, 'r') { |f| f.read } | ||
| # we pass svg-targeting css classes through here, ex. .svg-color--blue. The class targets fill, stroke, poly, circle, etc. | ||
| css_class = options[:class] | ||
| aspect_ratio = options[:preserveAspectRatio] |
There was a problem hiding this comment.
Lint/UselessAssignment: Useless assignment to variable - aspect_ratio.
guides/helpers/image_helpers.rb
Outdated
| def inline_svg(filename, options = {}) | ||
| asset = "source/assets/images/#{filename}" | ||
|
|
||
| if File.exists?(asset) |
There was a problem hiding this comment.
Lint/DeprecatedClassMethods: File.exists? is deprecated in favor of File.exist?.
guides/helpers/image_helpers.rb
Outdated
| @@ -0,0 +1,51 @@ | |||
| # Middleman - Inline SVG Helper | |||
There was a problem hiding this comment.
Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true.
guides/helpers/custom_helpers.rb
Outdated
| cls = "" | ||
| end | ||
| end | ||
| return cls |
There was a problem hiding this comment.
Style/RedundantReturn: Redundant return detected.
guides/helpers/custom_helpers.rb
Outdated
| def nav_inactive(paths) | ||
| cls = "no-active" | ||
| paths.each do |path| | ||
| if(current_page.path.start_with? path) |
There was a problem hiding this comment.
Layout/SpaceAroundKeyword: Space after keyword if is missing.
guides/helpers/custom_helpers.rb
Outdated
| @@ -0,0 +1,37 @@ | |||
| module CustomHelpers | |||
| def full_title(page_title=nil, site_title) | |||
There was a problem hiding this comment.
Style/OptionalArguments: Optional arguments should appear at the end of the argument list.
Layout/SpaceAroundEqualsInParameterDefault: Surrounding space missing in default value assignment.
guides/helpers/custom_helpers.rb
Outdated
| @@ -0,0 +1,37 @@ | |||
| module CustomHelpers | |||
There was a problem hiding this comment.
Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true.
guides/config.rb
Outdated
|
|
||
| def discover_title(page = current_page) | ||
| page_title = current_page.data.title || retrieve_page_header(page) | ||
| category = page.path[/\/(.*?)\/.*\.html/, 1]&.gsub('-', ' ')&.capitalize |
There was a problem hiding this comment.
Lint/Syntax: unexpected token error
guides/Gemfile
Outdated
| @@ -0,0 +1,8 @@ | |||
| source "https://rubygems.org" | |||
There was a problem hiding this comment.
Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true.
guides/helpers/custom_helpers.rb
Outdated
| # frozen_string_literal: true | ||
|
|
||
| module CustomHelpers | ||
| def full_title(site_title, page_title=nil) |
There was a problem hiding this comment.
Layout/SpaceAroundEqualsInParameterDefault: Surrounding space missing in default value assignment.
jgayfer
force-pushed
the
move_docs
branch
2 times, most recently
from
81d257d
to
3e2fcae
Compare
|
I merged a PR on guides (#2742) 😬 . Can you please rebase against master? |
|
@kennyadsl Done! |
jgayfer
force-pushed
the
move_docs
branch
3 times, most recently
from
0131474
to
c625895
Compare
|
@tvdeyen I've rebased against master |
The docs index wasn't meant to be a long term solution; it was a means to aid in navigating the docs while on GitHub. Since the docs will now live in their own site, there won't be a need to navigate the docs on GitHub.
This is a requirement of Middleman, the platform the docs site is built on. Otherwise, we can't generate HTML from the markdown.
This change allows for relative links to work in the context of the docs site.
This change keeps the original top level file/directory names as we had previously.
|
@tvdeyen Rebased |
|
Thanks! |
This PR depends on #2739
This PR moves all of the existing documentation to the new docs site.
There are a few changes that had to be made to the docs in order to have them play nice with Middleman.
.mdto.html.md.mdto.htmlOther than what is mentioned above, there are no changes made to the docs themselves. The goal was to keep the docs as pure markdown to ensure they remain platform agnostic should they be used in a different capacity in the future.