Skip to content

Commit 0f5d87c

Browse files
cwaringcwaring
authored
Merge pull request #2 from ipfs/feat-add-files-nav
Added files and nav
2 parents 0471975 + f2dc980 commit 0f5d87c

Some content is hidden

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

47 files changed

+2370
-481
lines changed

‎docs/.vuepress/config.js

Lines changed: 182 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// .vuepress/config.js
22
module.exports = {
3+
base: '/',
34
head: require('./head'),
45
locales: {
56
'/': {
@@ -11,7 +12,6 @@ module.exports = {
1112
themeConfig: {
1213
logo: '/images/ipfs-logo.svg',
1314
smoothScroll: true,
14-
sidebar: 'auto',
1515
editLinks: true,
1616
locales: {
1717
'/': {
@@ -21,7 +21,187 @@ module.exports = {
2121
editLinkText: 'Edit this page on GitHub',
2222
lastUpdated: 'Last Updated',
2323
nav: require('./nav/en'),
24-
sidebar: 'auto'
24+
sidebar: [
25+
'/install/',
26+
{
27+
title: 'Essentials',
28+
path: '/essentials/',
29+
children: [
30+
{
31+
title: 'IPFS in a nutshell',
32+
sidebarDepth: 1,
33+
collapsable: false,
34+
children: [
35+
'/essentials/what-is-ipfs',
36+
'/essentials/how-ipfs-works',
37+
'/essentials/usage-ideas-examples',
38+
'/essentials/glossary',
39+
'/essentials/faq'
40+
]
41+
},
42+
{
43+
title: 'Content-addressed storage',
44+
sidebarDepth: 1,
45+
collapsable: false,
46+
children: [
47+
'/essentials/content-addressing',
48+
'/essentials/hashing',
49+
'/essentials/immutability',
50+
'/essentials/persistence'
51+
]
52+
},
53+
{
54+
title: 'Peer-to-peer sharing',
55+
sidebarDepth: 1,
56+
collapsable: false,
57+
children: [
58+
'/essentials/merkle-dags',
59+
'/essentials/bitswap',
60+
'/essentials/ipld',
61+
'/essentials/ipns',
62+
'/essentials/libp2p',
63+
'/essentials/file-systems'
64+
]
65+
},
66+
{
67+
title: 'Integrating with the Web',
68+
sidebarDepth: 1,
69+
collapsable: false,
70+
children: ['/essentials/ipfs-gateway', '/essentials/dnslink']
71+
}
72+
]
73+
},
74+
{
75+
title: 'How-tos',
76+
path: '/how-tos/',
77+
children: [
78+
{
79+
title: 'Customize your install',
80+
sidebarDepth: 1,
81+
collapsable: false,
82+
children: [
83+
'/how-tos/configure-node',
84+
'/how-tos/modify-peers-list',
85+
['http://ipfs.io', 'Customize an IPFS repo']
86+
]
87+
},
88+
{
89+
title: 'Manage files',
90+
sidebarDepth: 1,
91+
collapsable: false,
92+
children: [
93+
[
94+
'https://github.com/ipfs/js-ipfs/tree/master/examples/ipfs-101',
95+
'Spawn a node (JS)'
96+
],
97+
[
98+
'https://github.com/ipfs/go-ipfs/tree/master/docs/examples/go-ipfs-as-a-library/README.md',
99+
'Spawn a node (Go)'
100+
],
101+
'/how-tos/work-with-blocks',
102+
'/how-tos/pin-files',
103+
['http://ipfs.io', 'Troubleshoot file transfers'],
104+
['http://ipfs.io', 'Traverse IPLD graphs'],
105+
'/how-tos/take-snapshot',
106+
'/how-tos/store-play-videos',
107+
'/how-tos/host-git-style-repo',
108+
['http://ipfs.io', 'Replicate large datasets']
109+
]
110+
},
111+
{
112+
title: 'Work with peers',
113+
sidebarDepth: 1,
114+
collapsable: false,
115+
children: [
116+
'/how-tos/observe-peers',
117+
['http://ipfs.io', 'Customize libp2p bundles'],
118+
['http://ipfs.io', 'Use circuit relay']
119+
]
120+
},
121+
{
122+
title: 'Host websites',
123+
sidebarDepth: 1,
124+
collapsable: false,
125+
children: ['/how-tos/host-single-page-site']
126+
},
127+
{
128+
title: 'Work with blockchains',
129+
sidebarDepth: 1,
130+
collapsable: false,
131+
children: [['http://ipfs.io', 'Explore the Ethereum chain']]
132+
},
133+
{
134+
title: 'Build apps',
135+
sidebarDepth: 1,
136+
collapsable: false,
137+
children: [
138+
'/how-tos/make-service',
139+
['http://ipfs.io', 'Use the IPFS API'],
140+
['http://ipfs.io', 'Build a basic libp2p app']
141+
]
142+
},
143+
{
144+
title: 'IPFS in the browser',
145+
sidebarDepth: 1,
146+
collapsable: false,
147+
children: [
148+
[
149+
'http://ipfs.io-addressinginbrowsers',
150+
'Address IPFS on the Web'
151+
],
152+
['http://ipfs.io', 'Exchange files between nodes'],
153+
['http://ipfs.io', 'Use MFS in the browser'],
154+
['http://ipfs.io', 'Add directories using streams'],
155+
['http://ipfs.io', 'Make a pubsub room'],
156+
['http://ipfs.io', 'Edit collaboratively with CRDT'],
157+
['http://ipfs.io', 'Stream video'],
158+
'/how-tos/browser-tools-frameworks'
159+
]
160+
}
161+
]
162+
},
163+
{
164+
title: 'API & CLI',
165+
path: '/reference/',
166+
children: [
167+
'/reference/js/api',
168+
'/reference/go/api',
169+
'/reference/http/api',
170+
'/reference/cli'
171+
]
172+
},
173+
{
174+
title: 'Support & community',
175+
path: '/support-community/',
176+
children: [
177+
['https://discuss.ipfs.io/', 'IPFS forums'],
178+
'/support-community/irc',
179+
[
180+
'https://calendar.google.com/calendar/embed?src=ipfs.io_eal36ugu5e75s207gfjcu0ae84@group.calendar.google.com',
181+
'Community video calls'
182+
],
183+
['https://proto.school/#/chapters', 'ProtoSchool chapters'],
184+
['https://www.meetup.com/members/249142444/', 'Meetups'],
185+
'/support-community/social-media',
186+
['http://ipfs.io', 'Awesome IPFS']
187+
]
188+
},
189+
{
190+
title: 'Project',
191+
path: '/project/',
192+
children: [
193+
['http://ipfs.io', 'History'],
194+
['http://ipfs.io', 'Roadmap'],
195+
['http://ipfs.io', 'Implementation status'],
196+
['http://ipfs.io', 'Specifications'],
197+
['http://ipfs.io', 'Research'],
198+
['http://ipfs.io', 'Team org planning'],
199+
'/project/related-projects',
200+
'/project/contribute',
201+
['http://ipfs.io', 'Code of conduct']
202+
]
203+
}
204+
]
25205
}
26206
}
27207
},

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

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
@import 'sidebar'
2+
13
#app
24
.theme-container
35
max-width: 1080px;
@@ -15,5 +17,4 @@
1517
.site-name
1618
&:hover
1719
&:after
18-
top: -9px
19-
20+
top: -9px

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
// 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+
28+
.icon.outbound
29+
padding-left: 0.2rem

‎docs/README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22
title: IPFS Documentation
33
---
44

5-
Welcome to the IPFS documentation portal! Whether you’re just learning about IPFS or are looking for detailed reference information, this is the place to start. You might have noticed that IPFS is a project with a big scope — and a *lot* of different tools, sites, and code.
5+
### ALERT! Links in this page are broken; they're ported straight from legacy docs.
6+
7+
Welcome to the IPFS documentation portal! Whether you’re just learning about IPFS or are looking for detailed reference information, this is the place to start. You might have noticed that IPFS is a project with a big scope — and a _lot_ of different tools, sites, and code.
68

79
Here’s an overview of what you’ll find in our documentation:
810

@@ -26,12 +28,10 @@ If you are using IPFS via the [command line](/reference/api/cli) or [interacting
2628

2729
IPFS is fundamentally a set of protocols for communicating about a distributed system of files, but those protocols are informed by reference implementations in both [Go](/reference/go/overview) and [JavaScript](/reference/js/overview). The Go implementation is more mature and implements more of the IPFS protocols, but the JS implementation can be used in a broader variety of requirements (including in web browsers).
2830

29-
3031
### Specifications & Planning
3132

3233
While IPFS has two reference implementations (in Go and JavaScript), it is fundamentally a set of protocols for formatting and communicating about distributed file systems. You can find specifications for those protocols, whitepapers, and information about our RFC (Request for Change) process in the “specifications & planning” section.
3334

34-
3535
## Community
3636

3737
Get in touch with other members of the IPFS community who are building tools on top of IPFS or even helping to build IPFS itself! You can ask questions, discuss new ideas, or get support for problems at https://discuss.ipfs.io, but you can also [hop on IRC](/community/irc) for a quick chat.
@@ -40,23 +40,20 @@ See the other links in the community section for more information about meetings
4040

4141
Information about contributing to IPFS and about other software projects in the community are also hosted here.
4242

43-
4443
### Applications
4544

4645
Both the Go and JavaScript implementations of IPFS are written to function as libraries and command-line applications with relatively restricted functionality. We are working on a variety of other applications that make use of IPFS, like GUI applications, browser extensions, and clustering tools for managing large data archives. You can find more about them here.
4746

48-
4947
### Get Involved
5048

5149
IPFS is an open-source community project. While [Protocol Labs](https://protocol.ai) is able to sponsor some of the work around it, much of the design, code, and effort is contributed by volunteers and community members like you. If you’re interested in helping improve IPFS, check the [how to help](/community/contribute/how-to-help) guide to get started.
5250

5351
If you are diving in to contribute new code, make sure you check both the [contribution guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md) and the style guide for your language ([Go](https://github.com/ipfs/community/blob/master/CONTRIBUTING_GO.md), [JavaScript](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md)).
5452

55-
5653
### Related Projects
5754

5855
We’ve split out some of the major parts of IPFS into separate projects over time — while they’re still critical components of IPFS, they can be useful in a variety of other contexts, too. Check their individual sites for specific information and references:
5956

6057
- [Libp2p](https://libp2p.io) manages all the peer-to-peer networking parts of IPFS.
61-
- [Multiformats](https://multiformats.io) is a variety of *self-describing* data formats.
58+
- [Multiformats](https://multiformats.io) is a variety of _self-describing_ data formats.
6259
- [IPLD](https://ipld.io) is a set of tools for describing links between content-addressed data, like IPFS files, Git commits, or Ethereum blocks.

‎docs/essentials/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Essentials
3+
---
4+
5+
# IPFS essentials
6+
7+
You get to this main page when you click on the highest-level nav. What goes here?

‎docs/essentials/bitswap.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Bitswap
3+
---
4+
5+
# Bitswap
6+
7+
Content to come.

‎docs/essentials/content-addressing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Content addressing
3+
---
4+
5+
# Content addressing and CIDs
6+
7+
Content to come.

‎docs/essentials/dnslink.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: DNSLink
3+
---
4+
5+
# DNSLink
6+
7+
Content to come.

‎docs/essentials/faq.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: FAQ
3+
---
4+
5+
# Frequently Asked Questions
6+
7+
Content to come. Let's use H2s for topic areas, rather than individual questions, so this doesn't get too long in the left nav.
8+
9+
## Topic area 1
10+
11+
### Individual question
12+
13+
Individual answer
14+
15+
### Individual question
16+
17+
Individual answer
18+
19+
## Topic area 2
20+
21+
### Individual question
22+
23+
Individual answer
24+
25+
### Individual question
26+
27+
Individual answer

‎docs/essentials/file-systems.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: File systems
3+
---
4+
5+
# File systems and IPFS
6+
7+
## Mutable File System (MFS)
8+
9+
This was its own page, but short
10+
11+
## UnixFS
12+
13+
This was its own page, but short

‎docs/essentials/glossary.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Glossary
3+
---
4+
5+
# IPFS Glossary
6+
7+
Content to come.

‎docs/essentials/hashing.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Hashing
3+
---
4+
5+
# Cryptographic hashing
6+
7+
Content to come.

‎docs/essentials/how-ipfs-works.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: How IPFS works
3+
---
4+
5+
# How IPFS works
6+
7+
Content to come. Probably lots of H2s here.

0 commit comments

Comments
 (0)