Skip to content

Commit 2cfc51c

Browse files
calvellidotruizlop
calvellido
authored and
truizlop
committed
Website styles adaptation (#21)
* Update deployment scripts * Update gitignore * Update Gemfile.lock dependencies versions * Update config.yml values * Update assets for Bow OpenAPI proper ones * Update layouts * Adapt styles to Bow OpenAPI visual proposal * Update JS logic * Update navbar colour on scroll for a lighter one * Remove incorrect reference * Correct placeholder URLs
1 parent 6c638a9 commit 2cfc51c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+1225
-1111
lines changed

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Podfile.lock
4242
_site
4343
.sass-cache
4444
.jekyll-metadata
45+
.jekyll-cache
4546

4647
## Ruby environment normalization:
4748
.bundle/

‎.travis.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,18 @@ jobs:
4545
- nef compile Documentation.app
4646
- stage: deploy microsite
4747
if: branch = master AND type != pull_request
48+
install:
49+
- gem install bundler --force
50+
- bundle install --gemfile docs/Gemfile --path vendor/bundle
4851
script:
4952
- nef jekyll --project Documentation.app --output docs --main-page Documentation.app/Jekyll/Home.md
53+
- BUNDLE_GEMFILE=./docs/Gemfile bundle exec jekyll build -s docs -d gen-docs
5054
deploy:
5155
provider: pages
5256
skip-cleanup: true
5357
github-token: $GITHUB_TOKEN
5458
keep-history: true
55-
local-dir: docs
59+
local-dir: gen-docs
5660
target-branch: gh-pages
5761
on:
5862
all_branches: true

‎docs/Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
source "https://rubygems.org"
22

3-
gem "jekyll", ">= 3.7.4"
3+
gem "jekyll", ">= 4.0.0"

‎docs/Gemfile.lock

100755100644
Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,65 @@
11
GEM
22
remote: https://rubygems.org/
33
specs:
4-
addressable (2.6.0)
5-
public_suffix (>= 2.0.2, < 4.0)
4+
addressable (2.7.0)
5+
public_suffix (>= 2.0.2, < 5.0)
66
colorator (1.1.0)
77
concurrent-ruby (1.1.5)
88
em-websocket (0.5.1)
99
eventmachine (>= 0.12.9)
1010
http_parser.rb (~> 0.6.0)
1111
eventmachine (1.2.7)
12-
ffi (1.10.0)
12+
ffi (1.12.1)
1313
forwardable-extended (2.6.0)
1414
http_parser.rb (0.6.0)
15-
i18n (0.9.5)
15+
i18n (1.8.2)
1616
concurrent-ruby (~> 1.0)
17-
jekyll (3.8.5)
17+
jekyll (4.0.0)
1818
addressable (~> 2.4)
1919
colorator (~> 1.0)
2020
em-websocket (~> 0.5)
21-
i18n (~> 0.7)
22-
jekyll-sass-converter (~> 1.0)
21+
i18n (>= 0.9.5, < 2)
22+
jekyll-sass-converter (~> 2.0)
2323
jekyll-watch (~> 2.0)
24-
kramdown (~> 1.14)
24+
kramdown (~> 2.1)
25+
kramdown-parser-gfm (~> 1.0)
2526
liquid (~> 4.0)
2627
mercenary (~> 0.3.3)
2728
pathutil (~> 0.9)
28-
rouge (>= 1.7, < 4)
29+
rouge (~> 3.0)
2930
safe_yaml (~> 1.0)
30-
jekyll-sass-converter (1.5.2)
31-
sass (~> 3.4)
31+
terminal-table (~> 1.8)
32+
jekyll-sass-converter (2.0.1)
33+
sassc (> 2.0.1, < 3.0)
3234
jekyll-watch (2.2.1)
3335
listen (~> 3.0)
34-
kramdown (1.17.0)
36+
kramdown (2.1.0)
37+
kramdown-parser-gfm (1.1.0)
38+
kramdown (~> 2.0)
3539
liquid (4.0.3)
36-
listen (3.1.5)
37-
rb-fsevent (~> 0.9, >= 0.9.4)
38-
rb-inotify (~> 0.9, >= 0.9.7)
39-
ruby_dep (~> 1.2)
40+
listen (3.2.1)
41+
rb-fsevent (~> 0.10, >= 0.10.3)
42+
rb-inotify (~> 0.9, >= 0.9.10)
4043
mercenary (0.3.6)
4144
pathutil (0.16.2)
4245
forwardable-extended (~> 2.6)
43-
public_suffix (3.0.3)
46+
public_suffix (4.0.3)
4447
rb-fsevent (0.10.3)
45-
rb-inotify (0.10.0)
48+
rb-inotify (0.10.1)
4649
ffi (~> 1.0)
47-
rouge (3.3.0)
48-
ruby_dep (1.5.0)
50+
rouge (3.15.0)
4951
safe_yaml (1.0.5)
50-
sass (3.7.4)
51-
sass-listen (~> 4.0.0)
52-
sass-listen (4.0.0)
53-
rb-fsevent (~> 0.9, >= 0.9.4)
54-
rb-inotify (~> 0.9, >= 0.9.7)
52+
sassc (2.2.1)
53+
ffi (~> 1.9)
54+
terminal-table (1.8.0)
55+
unicode-display_width (~> 1.1, >= 1.1.1)
56+
unicode-display_width (1.6.1)
5557

5658
PLATFORMS
5759
ruby
5860

5961
DEPENDENCIES
60-
jekyll (>= 3.7.4)
62+
jekyll (>= 4.0.0)
6163

6264
BUNDLED WITH
6365
2.1.1

‎docs/_config.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
1-
title: Bow-OpenAPI
21
#-------------------------
3-
name: Bow-OpenAPI
2+
title: Bow OpenAPI
3+
#-------------------------
4+
name: Bow OpenAPI # To be used on meta tags mainly
45
#-------------------------
56
description: A command-line tool to generate a Swift network client from an OpenAPI / Swagger specification file. Please, refer to the project website for extensive and detailed documentation about the project.
67
#-------------------------
78
author: 47 Degrees
89
keywords: functional-programming, monads, monad-transformers, functional-data-structure, swift, bow, xcode, xcode-playgrounds, playgrounds, fp-types, adt, free-monads, tagless-final, mtl, for-comprehension, category-theory
910
#-------------------------
11+
github-owner: bow-swift
12+
github-repo: bow-openapi
13+
#-------------------------
1014
url: https://openapi.bow-swift.io
1115
#-------------------------
1216
markdown: kramdown
1317
sass:
1418
sass_dir: _sass
1519
style: compressed
20+
sourcemap: never
1621
#-------------------------
1722
permalink: pretty
1823
#-------------------------

‎docs/_data/versions.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
- name: Version
2+
links:
3+
stable: https://openapi.bow-swift.io/
4+
next: https://openapi.bow-swift.io/
5+
6+
- name: API Docs
7+
links:
8+
stable: https://openapi.bow-swift.io/
9+
next: https://openapi.bow-swift.io/

‎docs/_includes/_doc.html

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,25 @@
1-
<main id="site-doc">
1+
<main id="site-doc" class="site-doc">
22
<div class="doc-header">
33
<button
4+
id="menu-toggle"
45
type="button"
56
class="button doc-toggle"
6-
title="Toggle"
7-
onClick="toggleClasses(['#site-sidebar', '#site-doc'], ['toggled', 'expanded'])">
8-
<img src="{{ site.baseurl }}/img/sidebar-icon-open.svg" alt="Toggle">
7+
title="Toggle">
8+
<img src="{{ 'img/sidebar-icon-open.svg' | relative_url }}" alt="Toggle" title="Toggle">
99
</button>
10+
11+
<div class="link-container">
12+
<!-- {% for item in site.data.versions %}
13+
{% include _dropdown.html item=item %}
14+
{% endfor %} -->
15+
<div class="link-item">
16+
<a href="https://github.com/{{ site.github-owner }}/{{ site.github-repo }}" title="GitHub repo" target="_blank" rel="noopener noreferrer">
17+
<span class="strong">GitHub</span>
18+
<span id="stars-count"></span>
19+
</a>
20+
</div>
21+
</div>
22+
1023
</div>
1124
<div class="doc-content">
1225
{{ content }}

‎docs/_includes/_dropdown.html

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<div id="{{ include.item.name | downcase | replace: ' ', '-' }}-dropdown" class="link-item">
2+
3+
<button class="button link-like strong" onclick="openDropdown(event)" title="{{ include.item.name }}">
4+
{% if include.item.icon != "" %}
5+
<i class="nav-item-icon fa fa-lg {{ include.item.icon }}" aria-hidden="true"></i>
6+
<span class="nav-item-text">{{ include.item.name }}</span>
7+
{% else %}
8+
<span class="nav-item-text">{{ include.item.name }}</span>
9+
{% endif %}
10+
</button>
11+
12+
<ul class="dropdown dropdown-content">
13+
{% for link in include.item.links %}
14+
<li class="dropdown-item">
15+
<a class="dropdown-item-link" title="{{ link[0] | capitalize }}" href="{{ link[1] }}" target="_blank" rel="noopener noreferrer">
16+
<span>
17+
{{ link[0] | capitalize }}
18+
</span>
19+
</a>
20+
</li>
21+
{% endfor %}
22+
</ul>
23+
24+
</div>

‎docs/_includes/_head-docs.html

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,38 @@
11
<head>
22
<meta charset="UTF-8">
3-
<title>{{site.name}}</title>
3+
4+
{% if page.title %}
5+
{% assign pageTitle = site.title | append: ': ' | append: page.title %}
6+
{% else %}
7+
{% assign pageTitle = site.title %}
8+
{% endif %}
9+
10+
<title>{{ pageTitle }}</title>
411
<meta name="viewport" content="width=device-width, initial-scale=1.0">
512
<meta name="description" content="{{site.description}}">
613
<meta name="keywords" content="{{site.keywords}}">
714

8-
<meta property="og:image" content="" />
9-
<meta property="og:title" content="{{site.name}}" />
10-
<meta property="og:site_name" content="{{site.name}}" />
15+
<meta property="og:image" content="{{ 'img/poster.png' | relative_url }}" />
16+
<meta property="og:title" content="{{ pageTitle }}" />
17+
<meta property="og:site_name" content="{{ pageTitle }}" />
1118
<meta property="og:url" content="{{ site.url }}" />
1219
<meta property="og:type" content="website" />
1320
<meta property="og:description" content="{{site.description}}" />
1421
<meta property="og:keywords" content="{{site.keywords}}" />
1522

1623
<meta name="twitter:text:description" content="{{site.description}}" />
1724
<meta name="twitter:card" content="summary_large_image">
18-
<meta name="twitter:site" content="@bow_swift">
19-
<meta name="twitter:creator" content="@bow_swift">
20-
<meta name="twitter:image" content="" />
25+
<meta name="twitter:site" content="@47deg">
26+
<meta name="twitter:creator" content="@47deg">
27+
<meta name="twitter:image" content="{{ 'img/poster.png' | relative_url }}" />
28+
29+
<meta property="github-info" data-github-owner="{{ site.github-owner }}" data-github-repo="{{ site.github-repo }}" />
2130

2231
<script defer src="{{ '/js/docs.js' | relative_url }}"></script>
2332

2433
<!-- Favicon -->
2534
<link rel="shortcut icon" href="{{ '/img/favicon.png' | relative_url }}">
2635

27-
<!-- Bow-OpenAPI docs css -->
36+
<!-- Docs css -->
2837
<link rel="stylesheet" type="text/css" href="{{ '/css/docs.css' | relative_url }}">
2938
</head>

0 commit comments

Comments
 (0)