Skip to content

Commit 17a4e47

Browse files
cwaringcwaring
authored
Merge pull request #9 from ipfs/layout
configure markdown plugins and associated styling
2 parents 113f6c2 + d4c74e7 commit 17a4e47

File tree

8 files changed

+1674
-320
lines changed

8 files changed

+1674
-320
lines changed

‎docs/.vuepress/config.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,15 @@ module.exports = {
99
description: 'IPFS Documentation'
1010
}
1111
},
12+
markdown: {
13+
extendMarkdown: md => {
14+
md.set({ breaks: true })
15+
md.use(require('markdown-it-video'))
16+
md.use(require('markdown-it-footnote'))
17+
md.use(require('markdown-it-task-lists'))
18+
md.use(require('markdown-it-deflist'))
19+
}
20+
},
1221
themeConfig: {
1322
logo: '/images/ipfs-logo.svg',
1423
smoothScroll: true,

‎docs/.vuepress/theme/styles/index.styl

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,31 @@
1-
@import 'sidebar'
1+
@import 'sidebar';
2+
@import 'video';
23

3-
#app
4-
.theme-container
5-
max-width: 1080px;
6-
.navbar .logo
7-
margin-right: 0.5rem
8-
.site-name:after
9-
content: "beta"
10-
font-size: 0.6rem
11-
margin-left: 0.5rem
12-
position: relative
13-
top: -7px
14-
background-color: $highlightColor
15-
padding: 0.2rem
16-
transition: all .5s
17-
.site-name
18-
&:hover
19-
&:after
20-
top: -9px
4+
#app {
5+
.theme-container {
6+
max-width: 1080px;
7+
}
8+
9+
.navbar .logo {
10+
margin-right: 0.5rem;
11+
}
12+
13+
.site-name:after {
14+
content: 'beta';
15+
font-size: 0.6rem;
16+
margin-left: 0.5rem;
17+
position: relative;
18+
top: -7px;
19+
background-color: $highlightColor;
20+
padding: 0.2rem;
21+
transition: all 0.5s;
22+
}
23+
24+
.site-name {
25+
&:hover {
26+
&:after {
27+
top: -9px;
28+
}
29+
}
30+
}
31+
}

‎docs/.vuepress/theme/styles/palette.styl

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
// showing default values
2-
$accentColor = #5db5be
3-
$textColor = #000000cc
4-
$borderColor = #eaecef
5-
$codeBgColor = #0e2233
6-
$highlightColor = #ffffa0
2+
$accentColor = #5db5be;
3+
$textColor = #000000cc;
4+
$borderColor = #eaecef;
5+
$codeBgColor = #0e2233;
6+
$highlightColor = #ffffa0;
77

88
:root {
9-
--accent-color: $accentColor
10-
--text-color: $textColor
11-
--border-color: $borderColor
12-
--code-bg-color: $codeBgColor
13-
--highlight-color: $highlightColor
9+
--accent-color: $accentColor;
10+
--text-color: $textColor;
11+
--border-color: $borderColor;
12+
--code-bg-color: $codeBgColor;
13+
--highlight-color: $highlightColor;
1414
}

‎docs/.vuepress/theme/styles/sidebar.styl

Lines changed: 48 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,58 @@
11
// custom sidebar overrides
2-
#app
3-
.sidebar-group a.sidebar-link
4-
padding-left: 1.25rem
5-
6-
.sidebar-group .arrow
7-
display: none
8-
9-
.sidebar-group.is-sub-group a.sidebar-link
10-
padding-left: 0.25rem
11-
12-
.sidebar-group.is-sub-group > .sidebar-group-items
13-
padding-left: 1.25rem
14-
15-
.sidebar-group.is-sub-group
16-
margin-bottom: 0.5rem
17-
18-
.sidebar-links.sidebar-group-items li:last-child .sidebar-group.is-sub-group
19-
margin-bottom: 0
20-
21-
.sidebar-group.is-sub-group > .sidebar-heading
22-
padding-left: 1.25rem
23-
24-
.sidebar-group.is-sub-group > .sidebar-heading:not(.clickable)
25-
opacity: 1
26-
font-weight: bold
27-
text-transform: uppercase
28-
font-size: .875em
29-
line-height: 2em
30-
31-
.icon.outbound
32-
padding-left: 0.2rem
2+
#app {
3+
.sidebar-group a.sidebar-link {
4+
padding-left: 1.25rem;
5+
}
6+
7+
.sidebar-group .arrow {
8+
display: none;
9+
}
10+
11+
.sidebar-group.is-sub-group a.sidebar-link {
12+
padding-left: 0.25rem;
13+
}
14+
15+
.sidebar-group.is-sub-group > .sidebar-group-items {
16+
padding-left: 1.25rem;
17+
}
18+
19+
.sidebar-group.is-sub-group {
20+
margin-bottom: 0.5rem;
21+
}
22+
23+
.sidebar-links.sidebar-group-items li:last-child .sidebar-group.is-sub-group {
24+
margin-bottom: 0;
25+
}
26+
27+
.sidebar-group.is-sub-group > .sidebar-heading {
28+
padding-left: 1.25rem;
29+
}
30+
31+
.sidebar-group.is-sub-group > .sidebar-heading:not(.clickable) {
32+
opacity: 1;
33+
font-weight: bold;
34+
text-transform: uppercase;
35+
font-size: 0.875em;
36+
line-height: 2em;
37+
}
38+
39+
.icon.outbound {
40+
padding-left: 0.2rem;
41+
}
42+
}
3343

3444
// sidebar scrollbar style
3545
.sidebar::-webkit-scrollbar {
36-
width: 5px;
37-
position: fixed;
38-
right: 0;
46+
width: 5px;
47+
position: fixed;
48+
right: 0;
3949
}
4050

4151
.sidebar::-webkit-scrollbar-thumb {
42-
background: transparent;
43-
transition: background-color 2s;
52+
background: transparent;
53+
transition: background-color 2s;
4454
}
4555

46-
.sidebar::-webkit-scrollbar-thumb:hover,.sidebar:hover::-webkit-scrollbar-thumb {
47-
background: $borderColor
56+
.sidebar::-webkit-scrollbar-thumb:hover, .sidebar:hover::-webkit-scrollbar-thumb {
57+
background: $borderColor;
4858
}

‎docs/.vuepress/theme/styles/video.styl

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.embed-responsive {
2+
padding-top: 56.25%;
3+
height: 0px;
4+
position: relative;
5+
}
6+
7+
.embed-responsive-16by9 > .embed-responsive-item {
8+
width: 100%;
9+
height: 100%;
10+
position: absolute;
11+
top: 0;
12+
left: 0;
13+
}

‎docs/essentials/file-systems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ MFS is accessed through the [`files`](/reference/api/cli/#ipfs-files) commands i
2121

2222
This video also provides a good overview of MFS:
2323

24-
<iframe width="560" height="315" src="https://www.youtube.com/embed/FX_AXNDsZ9k" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
24+
@[youtube](FX_AXNDsZ9k)
2525

2626
## UnixFS
2727

0 commit comments

Comments
 (0)