Skip to content

Commit d540f14

Browse files
m3num3nu
committed
Initial commit
0 parents  commit d540f14

13 files changed

+690
-0
lines changed

‎.gitignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
_site/
2+
.sass-cache/
3+
.jekyll-cache/
4+
.jekyll-metadata

‎.gitignore.exclude

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_site
2+
.sass-cache
3+
.jekyll-metadata

‎Gemfile

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
source "https://rubygems.org"
2+
3+
# Hello! This is where you manage which Jekyll version is used to run.
4+
# When you want to use a different version, change it below, save the
5+
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
6+
#
7+
# bundle exec jekyll serve
8+
#
9+
# This will help ensure the proper Jekyll version is running.
10+
# Happy Jekylling!
11+
gem "jekyll", "~> 3.8.6"
12+
13+
# This is the default theme for new Jekyll sites. You may change this to anything you like.
14+
gem "just-the-docs"
15+
16+
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
17+
# uncomment the line below. To upgrade, run `bundle update github-pages`.
18+
# gem "github-pages", group: :jekyll_plugins
19+
20+
# If you have any plugins, put them here!
21+
group :jekyll_plugins do
22+
gem "jekyll-feed", "~> 0.6"
23+
end
24+
25+
# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
26+
# and associated library.
27+
install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
28+
gem "tzinfo", "~> 1.2"
29+
gem "tzinfo-data"
30+
end
31+
32+
# Performance-booster for watching directories on Windows
33+
gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
34+

‎Gemfile.lock

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.6.0)
5+
public_suffix (>= 2.0.2, < 4.0)
6+
colorator (1.1.0)
7+
concurrent-ruby (1.1.5)
8+
em-websocket (0.5.1)
9+
eventmachine (>= 0.12.9)
10+
http_parser.rb (~> 0.6.0)
11+
eventmachine (1.2.7)
12+
ffi (1.11.1)
13+
forwardable-extended (2.6.0)
14+
http_parser.rb (0.6.0)
15+
i18n (0.9.5)
16+
concurrent-ruby (~> 1.0)
17+
jekyll (3.8.6)
18+
addressable (~> 2.4)
19+
colorator (~> 1.0)
20+
em-websocket (~> 0.5)
21+
i18n (~> 0.7)
22+
jekyll-sass-converter (~> 1.0)
23+
jekyll-watch (~> 2.0)
24+
kramdown (~> 1.14)
25+
liquid (~> 4.0)
26+
mercenary (~> 0.3.3)
27+
pathutil (~> 0.9)
28+
rouge (>= 1.7, < 4)
29+
safe_yaml (~> 1.0)
30+
jekyll-feed (0.12.1)
31+
jekyll (>= 3.7, < 5.0)
32+
jekyll-sass-converter (1.5.2)
33+
sass (~> 3.4)
34+
jekyll-seo-tag (2.6.1)
35+
jekyll (>= 3.3, < 5.0)
36+
jekyll-watch (2.2.1)
37+
listen (~> 3.0)
38+
just-the-docs (0.2.5)
39+
jekyll (~> 3.8.5)
40+
jekyll-seo-tag (~> 2.0)
41+
rake (~> 12.3.1)
42+
kramdown (1.17.0)
43+
liquid (4.0.3)
44+
listen (3.1.5)
45+
rb-fsevent (~> 0.9, >= 0.9.4)
46+
rb-inotify (~> 0.9, >= 0.9.7)
47+
ruby_dep (~> 1.2)
48+
mercenary (0.3.6)
49+
pathutil (0.16.2)
50+
forwardable-extended (~> 2.6)
51+
public_suffix (3.1.1)
52+
rake (12.3.2)
53+
rb-fsevent (0.10.3)
54+
rb-inotify (0.10.0)
55+
ffi (~> 1.0)
56+
rouge (3.6.0)
57+
ruby_dep (1.5.0)
58+
safe_yaml (1.0.5)
59+
sass (3.7.4)
60+
sass-listen (~> 4.0.0)
61+
sass-listen (4.0.0)
62+
rb-fsevent (~> 0.9, >= 0.9.4)
63+
rb-inotify (~> 0.9, >= 0.9.7)
64+
thread_safe (0.3.6)
65+
tzinfo (1.2.5)
66+
thread_safe (~> 0.1)
67+
tzinfo-data (1.2019.2)
68+
tzinfo (>= 1.0.0)
69+
wdm (0.1.1)
70+
71+
PLATFORMS
72+
ruby
73+
74+
DEPENDENCIES
75+
jekyll (~> 3.8.6)
76+
jekyll-feed (~> 0.6)
77+
just-the-docs
78+
tzinfo (~> 1.2)
79+
tzinfo-data
80+
wdm (~> 0.1.0)
81+
82+
BUNDLED WITH
83+
2.0.2

‎README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# BorgBase Know-How
2+
3+
Has the content of [docs.borgbase.com](https://docs.borgbase.com). Feel free to open a pull request if you notice any mistake or would like to add something.
4+
5+
## Setup
6+
- Install dependencies: `gem install --user-install jekyll bundler`
7+
- Run in project dir: `bundler install`
8+
9+
## Run
10+
- `bundle exec jekyll serve`
11+
12+
## Credits
13+
- Theme: [https://github.com/pmarsceill/just-the-docs]
14+
- Colors: [https://vuetifyjs.com/en/framework/colors#colors]

‎_config.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
title: BorgBase Docs
2+
description: A Jekyll theme for documentation
3+
baseurl: ""
4+
url: "https://docs.borgbase.com"
5+
6+
permalink: pretty
7+
exclude: ["README.md", "Rakefile"]
8+
9+
search_enabled: true
10+
11+
aux_links:
12+
"Borg Repo Hosting from $2/month":
13+
- "https://www.borgbase.com"
14+
15+
theme: just-the-docs
16+
color_scheme: nil
17+
18+
ga_tracking: UA-41046852-10
19+
20+
plugins:
21+
- jekyll-seo-tag

‎_sass/custom/custom.scss

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
// //
2+
// // Typography
3+
// //
4+
//
5+
// $body-font-family: -apple-system, BlinkMacSystemFont, "helvetica neue", helvetica, roboto, noto, "segoe ui", arial, sans-serif;
6+
// $mono-font-family: "SFMono-Regular", Menlo, Consolas, Monospace;
7+
// $root-font-size: 16px; // Base font-size for rems
8+
// $body-line-height: 1.4;
9+
// $body-heading-line-height: 1.15;
10+
//
11+
// //
12+
// // Colors
13+
// //
14+
//
15+
// $white: #fff;
16+
//
17+
// $grey-dk-000: #959396;
18+
// $grey-dk-100: #5c5962;
19+
// $grey-dk-200: #44434d;
20+
// $grey-dk-250: #302d36 !default;
21+
// $grey-dk-300: #27262b;
22+
//
23+
// $grey-lt-000: #f5f6fa;
24+
// $grey-lt-100: #eeebee;
25+
// $grey-lt-200: #ecebed;
26+
// $grey-lt-300: #e6e1e8;
27+
//
28+
// $purple-000: #7253ed;
29+
// $purple-100: #5e41d0;
30+
// $purple-200: #4e26af;
31+
// $purple-300: #381885;
32+
//
33+
// $blue-000: #2c84fa;
34+
// $blue-100: #2869e6;
35+
// $blue-200: #264caf;
36+
// $blue-300: #183385;
37+
//
38+
// $green-000: #41d693;
39+
// $green-100: #11b584;
40+
// $green-200: #009c7b;
41+
// $green-300: #026e57;
42+
//
43+
// $body-background-color: $white !default;
44+
// $sidebar-color: $grey-lt-000 !default;
45+
// $code-background-color: $grey-lt-000 !default;
46+
47+
// $body-text-color: $grey-dk-100 !default;
48+
// $body-heading-color: $grey-dk-300 !default;
49+
// $nav-child-link-color: $grey-dk-100 !default;
50+
51+
$orange-000: #FF9800;
52+
$orange-100: #FB8C00;
53+
54+
$link-color: $orange-000;
55+
$btn-primary-color: $orange-100;
56+
$base-button-color: #f7f7f7;
57+
58+
//
59+
// //
60+
// // Media queries in pixels
61+
// //
62+
//
63+
// $media-queries: (
64+
// xs: 320px,
65+
// sm: 500px,
66+
// md: 740px,
67+
// lg: 1120px,
68+
// xl: 1400px
69+
// );
70+
//
71+
// //
72+
// // Spacing
73+
// //
74+
//
75+
// $spacing-unit: 1rem; // 1rem == 16px
76+
//
77+
// $spacers: (
78+
// sp-0: 0,
79+
// sp-1: $spacing-unit * 0.25,
80+
// sp-2: $spacing-unit * 0.5,
81+
// sp-3: $spacing-unit * 0.75,
82+
// sp-4: $spacing-unit,
83+
// sp-5: $spacing-unit * 1.5,
84+
// sp-6: $spacing-unit * 2,
85+
// sp-7: $spacing-unit * 2.5,
86+
// sp-8: $spacing-unit * 3,
87+
// sp-9: $spacing-unit * 3.5,
88+
// sp-10: $spacing-unit * 4
89+
// );
90+
//
91+
// $sp-1: map-get($spacers, sp-1); // 0.25 rem == 4px
92+
// $sp-2: map-get($spacers, sp-2); // 0.5 rem == 8px
93+
// $sp-3: map-get($spacers, sp-3); // 0.75 rem == 12px
94+
// $sp-4: map-get($spacers, sp-4); // 1 rem == 16px
95+
// $sp-5: map-get($spacers, sp-5); // 1.5 rem == 24px
96+
// $sp-6: map-get($spacers, sp-6); // 2 rem == 32px
97+
// $sp-7: map-get($spacers, sp-7); // 2.5 rem == 40px
98+
// $sp-8: map-get($spacers, sp-8); // 3 rem == 48px
99+
// $sp-9: map-get($spacers, sp-9); // 4 rem == 48px
100+
// $sp-10: map-get($spacers, sp-10); // 4.5 rem == 48px
101+
//
102+
// //
103+
// // Borders
104+
// //
105+
//
106+
// $border: 1px solid;
107+
// $border-radius: 4px;
108+
// $border-color: $grey-lt-100;
109+
//
110+
// //
111+
// // Grid system
112+
// //
113+
//
114+
// $gutter-spacing: $sp-6;
115+
// $gutter-spacing-sm: $sp-4;
116+
// $nav-width: 232px;
117+
// $content-width: 800px;
118+
//
119+
// $media-queries: (
120+
// xs: 320px,
121+
// sm: 500px,
122+
// md: 740px,
123+
// lg: 800px,
124+
// xl: 1316px
125+
// );

0 commit comments

Comments
 (0)