Skip to content

Commit 9548fb9

Browse files
committed
initial commit
1 parent 418cf1d commit 9548fb9

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

+252
-1554
lines changed

README.md

-68
Original file line numberDiff line numberDiff line change
@@ -1,68 +0,0 @@
1-
<p align="right">
2-
<a href="https://badge.fury.io/rb/just-the-docs"><img src="https://badge.fury.io/rb/just-the-docs.svg" alt="Gem version"></a> <a href="https://github.com/pmarsceill/just-the-docs/actions"><img src="https://github.com/pmarsceill/just-the-docs/workflows/CI/badge.svg" alt="Build status"></a>
3-
</p>
4-
<br><br>
5-
<p align="center">
6-
<h1 align="center">Just the Docs</h1>
7-
<p align="center">A modern, high customizable, responsive Jekyll theme for documentation with built-in search.<br>Easily hosted on GitHub Pages with few dependencies.</p>
8-
<p align="center"><strong><a href="https://pmarsceill.github.io/just-the-docs/">See it in action!</a></strong></p>
9-
<br><br><br>
10-
</p>
11-
12-
![jtd](https://user-images.githubusercontent.com/896475/47384541-89053c80-d6d5-11e8-98dc-dba16e192de9.gif)
13-
14-
## Installation
15-
16-
Add this line to your Jekyll site's Gemfile:
17-
18-
```ruby
19-
gem "just-the-docs"
20-
```
21-
22-
And add this line to your Jekyll site's `_config.yml`:
23-
24-
```yaml
25-
theme: just-the-docs
26-
```
27-
28-
And then execute:
29-
30-
$ bundle
31-
32-
Or install it yourself as:
33-
34-
$ gem install just-the-docs
35-
36-
## Usage
37-
38-
[View the documentation](https://pmarsceill.github.io/just-the-docs/) for usage information.
39-
40-
## Contributing
41-
42-
Bug reports and pull requests are welcome on GitHub at https://github.com/pmarsceill/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
43-
44-
### Submitting code changes:
45-
46-
- Open a [Pull Request](https://github.com/pmarsceill/just-the-docs/pulls)
47-
- Ensure all CI tests pass
48-
- Await code review
49-
- Bump the version number in `just-the-docs.gemspec` and `package.json` according to [semantic versioning](https://semver.org/).
50-
51-
### Design and development principles of this theme:
52-
53-
1. As few dependencies as possible
54-
2. No build script needed
55-
3. First class mobile experience
56-
4. Make the content shine
57-
58-
## Development
59-
60-
To set up your environment to develop this theme, run `bundle install`.
61-
62-
Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
63-
64-
When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
65-
66-
## License
67-
68-
The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

_config.yml

+8-7
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@
1313
# you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
1414
# You can create any custom variable you would like, and they will be accessible
1515
# in the templates via {{ site.myvariable }}.
16-
title: Just the Docs
17-
description: A Jekyll theme for documentation
18-
baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
16+
title: BitBox
17+
description: User guides for our products
18+
baseurl: "" # the subpath of your site, e.g. /blog
1919
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
20+
support: "(mailto:[email protected])"
2021

2122
permalink: pretty
2223
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
@@ -29,18 +30,18 @@ heading_anchors: true
2930

3031
# Aux links for the upper right navigation
3132
aux_links:
32-
"Just the Docs on GitHub":
33-
- "//github.com/pmarsceill/just-the-docs"
33+
"Contact support":
34+
- "mailto:[email protected]"
3435

3536
# Footer content appears at the bottom of every page's main content
36-
footer_content: "Copyright &copy; 2017-2019 Patrick Marsceill. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
37+
footer_content: "Copyright &copy; 2017-2019 Shift Cryptosecurity. Distributed by an <a href=\"https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt\">MIT license.</a>"
3738

3839
# Color scheme currently only supports "dark" or nil (default)
3940
color_scheme: nil
4041

4142
# Google Analytics Tracking (optional)
4243
# e.g, UA-1234567-89
43-
ga_tracking: UA-2709176-10
44+
ga_tracking:
4445

4546
plugins:
4647
- jekyll-seo-tag

assets/images/.DS_Store

6 KB
Binary file not shown.
15 KB
Loading
100 KB
Loading
35 KB
Loading
136 KB
Loading
19.9 KB
Loading
112 KB
Loading
16.9 KB
Loading
126 KB
Loading
19.7 KB
Loading
175 KB
Loading
28.4 KB
Loading
163 KB
Loading
13.9 KB
Loading
8.02 KB
Loading
Loading
12.3 KB
Loading
7.98 KB
Loading
Loading
536 KB
Loading

docs/bitbox01/bitbox01.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
layout: default
3+
title: BitBox01
4+
nav_order: 2
5+
has_children: true
6+
permalink: /docs/BitBox01
7+
---
8+
9+
# {{page.title}}
10+
{: .no_toc }
11+
12+
## Table of contents
13+
{: .no_toc .text-delta }
14+
15+
1. TOC
16+
{:toc}
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: default
3+
title: Backup
4+
nav_order: 3
5+
has_children: false
6+
parent: Getting-started
7+
grand_parent: BitBox02
8+
---
9+
10+
# {{page.grand_parent}}: {{page.title}}
11+
{: .no_toc }
12+
13+
## Table of contents
14+
{: .no_toc .text-delta }
15+
16+
1. TOC
17+
{:toc}
18+
19+
---
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
layout: default
3+
title: Getting-started
4+
nav_order: 1
5+
has_children: true
6+
parent: BitBox02
7+
permalink: /docs/bitbox02/Getting-started
8+
---
9+
10+
# {{page.parent}}: {{page.title}}
11+
{: .no_toc }
12+
13+
These are the steps we will take together to get you started:
+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
layout: default
3+
title: Setup
4+
nav_order: 2
5+
has_children: false
6+
parent: Getting-started
7+
grand_parent: BitBox02
8+
---
9+
10+
# {{page.grand_parent}}: {{page.title}}
11+
{: .no_toc }
12+
13+
## Table of contents
14+
{: .no_toc .text-delta }
15+
16+
1. TOC
17+
{:toc}
18+
19+
---
20+
21+
## Download the BitBox App
22+
In order to set up your BitBox02 and create your first wallet you need to download the BitBox App for your computer.
23+
Stay tuned for our mobile app! To be notified when it is available you can subscribe to our newsletter here.
24+
25+
[Download](https://shiftcrypto.ch/start/){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
26+
27+
28+
---
29+
30+
## Launch the BitBox app
31+
32+
Once the download is finished, please unpack the app (doube-click on it) and pull it into your application folder.
33+
34+
Then double-click it to launch it.
35+
36+
You should then see a screen that asks you to plug in your BitBox device.
37+
38+
![alt text](/assets/images/BitBoxApp/BitBox_App_waiting.png "BitBox App")
39+
40+
41+
---
42+
43+
## Plug in your BitBox device
44+
Before you plug in your BitBox, please already insert the microSD card which will be needed in a later step. When done, please plug the BitBox into your computer. Depending on the available ports you might need to use the USB-C to USB-A adapter that came with your BitBox.
45+
46+
---
47+
48+
## Follow the setup-wizard
49+
50+
Once the BitBox is plugged in, the setup-wizard should start which will guide you through the process of setting up your BitBox, creating and backing up your wallet.
51+
52+
### Step 1
53+
### Step 2
54+
### Step 3
+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
layout: default
3+
title: Unboxing
4+
nav_order: 1
5+
has_children: false
6+
parent: Getting-started
7+
grand_parent: BitBox02
8+
---
9+
10+
# {{page.grand_parent}}: {{page.title}}
11+
{: .no_toc }
12+
13+
## Table of contents
14+
{: .no_toc .text-delta }
15+
16+
1. TOC
17+
{:toc}
18+
19+
---
20+
21+
## Thank you
22+
23+
for buying a Shift Cryptosecurity product. We hope you will enjoy using it. If you can't find what you're looking for in this guide, please don't hesitate to [contact us](mailto:[email protected])
24+
25+
---
26+
27+
## Packaging
28+
29+
Before you start using your device, please make sure that the vacuum bag is still sealed with the original bag.
30+
31+
Here is a photo of what it should look like:
32+
33+
![alt text](/assets/images/BitBox02/06_bb02_vac.png "BitBox02 in vacuum bag")
34+
35+
36+
## In the box
37+
38+
The following items should be in your box:
39+
* BitBox02 Device
40+
* microSD card
41+
* USB-C extension cable
42+
* USB-C to USB-A adapter
43+
* BitBox stickers
44+
* Rubber pulls
45+
46+
![alt text](/assets/images/BitBox02/04_bb02_open_box.png "BitBox02 box")
47+
![alt text](/assets/images/BitBox02/03_bb02_accessories.png "BitBox02 accessories")

docs/bitbox02/bitbox02.md

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: default
3+
title: BitBox02
4+
nav_order: 3
5+
has_children: true
6+
permalink: /docs/BitBox02
7+
---
8+
9+
# {{page.title}}
10+
{: .no_toc }
11+
12+
## Table of contents
13+
{: .no_toc .text-delta }
14+
15+
1. TOC
16+
{:toc}
17+
18+
---
19+
20+
## Device description
21+
22+
The main navigation for your Just the Docs site is on the left side of the page at large screens and on the top (behind a tap) on small screens. The main navigation can be structured to accommodate a multi-level menu system (pages with children and grandchildren).
23+
24+
By default, all pages will appear as top level pages in the main nav unless a parent page is defined (see [Pages with Children](#pages-with-children)).
25+
26+
---
27+
28+
## Device pictures
29+
30+
IMAGES
31+
32+
33+
## Datasheet
34+
35+
36+
[Download Datasheet](){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
37+
38+
39+
---
40+
41+
## Firmware log
42+
A list of all firmware versions with a changelog

docs/bitbox02_btc.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: default
3+
title: BitBox02 - BTC only
4+
nav_order: 4
5+
---
6+
7+
# {{page.title}}
8+
{: .no_toc }
9+
10+
11+
These guides are still being written, please stay tuned.

docs/bitbox_app.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
layout: default
3+
title: BitBox App
4+
nav_order: 5
5+
---
6+
7+
# {{page.title}}
8+
{: .no_toc }
9+
10+
11+
These guides are still being written, please stay tuned.

docs/bitbox_app_mobile.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: default
3+
title: BitBox App Mobile
4+
nav_order: 5
5+
nav_exclude: true
6+
7+
---
8+
9+
# {{page.title}}
10+
{: .no_toc }
11+
12+
Nothing to see here yet. Stay tuned!

0 commit comments

Comments
 (0)