Skip to content

desktop layout revamp #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .codesandbox/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,10 @@
],

// These tasks can be run from CodeSandbox. Running one will open a log in the app.
"tasks": {}
"tasks": {
"ruby:typecheck": {
"name": "Typecheck",
"command": "solargraph typecheck"
}
}
}
22 changes: 22 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/jekyll
{
"name": "Jekyll",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"image": "mcr.microsoft.com/devcontainers/jekyll:2-bullseye"

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "jekyll --version"

// Configure tool-specific properties.
// "customizations": {},

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
16 changes: 10 additions & 6 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for more information:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
# https://containers.dev/guide/dependabot

version: 2
updates:
- package-ecosystem: bundler
directory: /
schedule:
interval: daily
allow:
- dependency-type: direct
- package-ecosystem: "devcontainers"
directory: "/"
schedule:
interval: weekly
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,5 @@ group :jekyll_plugins do
gem "jekyll-sitemap"
gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
gem "base64", "~> 0.2.0"
gem 'csv'
end
14 changes: 12 additions & 2 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ GEM
bigdecimal (3.2.2)
colorator (1.1.0)
concurrent-ruby (1.3.5)
csv (3.3.5)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
Expand All @@ -20,12 +21,16 @@ GEM
faraday-retry (2.3.2)
faraday (~> 2.0)
ffi (1.17.2-arm64-darwin)
ffi (1.17.2-x64-mingw-ucrt)
ffi (1.17.2-x86_64-darwin)
ffi (1.17.2-x86_64-linux-gnu)
forwardable-extended (2.6.0)
google-protobuf (4.31.1-arm64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.31.1-x64-mingw-ucrt)
bigdecimal
rake (>= 13)
google-protobuf (4.31.1-x86_64-darwin)
bigdecimal
rake (>= 13)
Expand Down Expand Up @@ -96,9 +101,12 @@ GEM
rexml (3.4.1)
rouge (4.6.0)
safe_yaml (1.0.5)
sass-embedded (1.89.2)
sass-embedded (1.89.2-arm64-darwin)
google-protobuf (~> 4.31)
sass-embedded (1.89.2-x86_64-darwin)
google-protobuf (~> 4.31)
sass-embedded (1.89.2-x86_64-linux-gnu)
google-protobuf (~> 4.31)
rake (>= 13)
sawyer (0.9.2)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
Expand All @@ -110,11 +118,13 @@ GEM

PLATFORMS
arm64-darwin
x64-mingw-ucrt
x86_64-darwin
x86_64-linux

DEPENDENCIES
base64 (~> 0.2.0)
csv
faraday-retry
jekyll (~> 4.3.2)
jekyll-github-metadata (>= 2.15)
Expand Down
10 changes: 5 additions & 5 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ search:
# Supports true or false (default)
button: true
# Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
focus_shortcut_key: 'k'
focus_shortcut_key: "k"

# For copy button on code
enable_copy_code_button: true
Expand All @@ -69,8 +69,8 @@ heading_anchors: true

# Aux links for the upper right navigation
aux_links:
"BIRDSOpenSource on GitHub":
- "{{site.github_org}}"
"GitHub":
- "https://github.com/BIRDSOpenSource/BIRDSOpenSource.github.io"

# Makes Aux links open in a new tab. Default is false
aux_links_new_tab: true
Expand All @@ -83,7 +83,7 @@ nav_enabled: true
color_schemes:
- light
- dark

color_scheme: dark

# # Define Jekyll collections
Expand All @@ -104,7 +104,7 @@ callouts:
title: Warning
color: red
opacity: 0.3

caution:
title: Caution
color: yellow
Expand Down
172 changes: 140 additions & 32 deletions _includes/head.html
Original file line number Diff line number Diff line change
@@ -1,51 +1,159 @@
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=Edge">

<link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">

{% if site.ga_tracking != nil %}
{% assign ga_tracking_ids = site.ga_tracking | split: "," %}
<script async src="https://www.googletagmanager.com/gtag/js?id={{ ga_tracking_ids.first }}"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

{% for ga_property in ga_tracking_ids %}
gtag('config', '{{ ga_property }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
{% endfor %}
</script>
{% endif %}
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&family=Geist:[email protected]&family=Open+Sans:ital,wght@0,300..800;1,300..800&family=Red+Rose:[email protected]&display=swap"
rel="stylesheet"
/>
<link
rel="stylesheet"
href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}"
/>

{% if site.ga_tracking != nil %} {% assign ga_tracking_ids = site.ga_tracking
| split: "," %}
<script
async
src="https://www.googletagmanager.com/gtag/js?id={{ ga_tracking_ids.first }}"
></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

{% if site.search_enabled != false %}
<script src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
{% for ga_property in ga_tracking_ids %}
gtag('config', '{{ ga_property }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
{% endfor %}
</script>
{% endif %} {% if site.search_enabled != false %}
<script src="{{ '/assets/js/vendor/lunr.min.js' | relative_url }}"></script>
{% endif %}

<script src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>

<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="viewport" content="width=device-width, initial-scale=1" />

{% for file in site.static_files %}
{% if file.path == site.favicon_ico or file.path == '/favicon.ico' %}
{% assign favicon = true %}
{% endif %}
{% endfor %}
{% if favicon %}
<link rel="icon" href="{{ site.favicon_ico | default: '/favicon.ico' | relative_url }}" type="image/x-icon">
{% for file in site.static_files %} {% if file.path == site.favicon_ico or
file.path == '/favicon.ico' %} {% assign favicon = true %} {% endif %} {%
endfor %} {% if favicon %}
<link
rel="icon"
href="{{ site.favicon_ico | default: '/favicon.ico' | relative_url }}"
type="image/x-icon"
/>
{% endif %}

<script>
window.MathJax = {
tex: { inlineMath: [['$', '$'], ['\\(', '\\)']] },
svg: { fontCache: 'global' }
tex: {
inlineMath: [
["$", "$"],
["\\(", "\\)"],
],
},
svg: { fontCache: "global" },
};
</script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js" async></script>
<script
src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"
async
></script>

{%- seo title=false -%}
<title>{{ site.data.l10n.title }}</title>

{% include head_custom.html %}

<style>
* {
font-family: "DM Sans", sans-serif;
scrollbar-width: thin;
scrollbar-color: #eaeaea transparent;
scrollbar-gutter: stable;
font-optical-sizing: auto;
}

body {
background-color: black !important;
}

@media (min-width: 1100px) {
body {
display: flex !important;
height: 100vh;
overflow-y: hidden;
}
.main {
margin-left: 0px;
max-width: calc(100% - 264px) !important;
height: 100%;
}
.main-content-wrap {
height: 100%;
overflow-y: auto;
}
.side-bar {
width: max-content !important;
min-width: none !important;
scrollbar-width: "none";
position: relative;
}
.site-nav {
overflow-y: scroll;
padding-top: 8px !important;
}
.main-header,
.main {
width: 100% !important;
}
}

a {
color: rgb(82, 168, 255) !important;
text-decoration: none !important;
}
p {
color: #ededed !important;
}

h1 {
line-height: 1 !important;
}
.main-header,
.search,
.search-input,
.side-bar {
background-color: black !important;
}
.site-nav {
color: #ededed !important;
}

.nav-list-link {
color: #a1a1a1 !important;
}

.nav-list-link.active {
color: rgb(82, 168, 255) !important;
background: none !important;
}

.site-button {
background-color: #0a0a0a !important;
color: #ededed !important;
border-left-width: 1px !important;
border-right-width: 1px !important;
border-color: #ededed !important;
display: "flex!important";
align-items: "center!important";
gap: 8px !important;
}

.site-button::before {
content: url("/assets/svg/github.svg");
height: 14px;
}
</style>
</head>
33 changes: 15 additions & 18 deletions _includes/nav_footer_custom.html
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
<span class="fs-2" align="right">
{%- assign date_format = site.data.l10n.date_format | default: "%b %-d, %Y" -%}
{{ site.time | date: date_format }} {{ site.data.l10n.title }}
<div>
<p style="margin-bottom: 0.3rem; ">
Using Just the Docs
</p>
<p style="margin: 0.4rem 0">
<a
href="https://birdsopensource.github.io/contribute"
target="_blank"
style="color: #e6e1e7; text-decoration: none"
>
Built with ❤️ by Kyutech LaSEINE
</a>
</p>
</div>
<span class="fs-2" align="left">
{%- assign date_format = site.data.l10n.date_format | default: "%b %-d, %Y"
-%} {{ site.time | date: date_format }} {{ site.data.l10n.title }}
<div>
<p style="margin-bottom: 0.3rem">Using Just the Docs</p>
<p style="margin: 0.4rem 0">
<a
href="https://birdsopensource.github.io/contribute"
target="_blank"
style="color: #e6e1e7; text-decoration: none"
>
Built with ❤️ by Kyutech LaSEINE
</a>
</p>
</div>
</span>

2 changes: 1 addition & 1 deletion _site/index.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions assets/svg/github.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading