Skip to content
This repository was archived by the owner on Nov 14, 2023. It is now read-only.

Commit 57c8ec8

Browse files
committed
feat: a docs site for web3.storage ⁂🎷🐩
there are many like it but this one is mine
0 parents  commit 57c8ec8

31 files changed

+6078
-0
lines changed

.eslintrc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "next/core-web-vitals"
3+
}

.gitignore

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
.yarn/install-state.gz
8+
9+
# testing
10+
/coverage
11+
12+
# next.js
13+
/.next/
14+
/out/
15+
16+
# production
17+
/build
18+
19+
# misc
20+
.DS_Store
21+
*.pem
22+
23+
# debug
24+
npm-debug.log*
25+
yarn-debug.log*
26+
yarn-error.log*
27+
28+
# local env files
29+
.env*.local
30+
31+
# vercel
32+
.vercel
33+
34+
# typescript
35+
*.tsbuildinfo
36+
next-env.d.ts

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# web3.storage/docs
2+
3+
Documenting how to use web3.storage.
4+
5+
**Under the hood, web3.storage is backed by the provable storage of [IPFS](https://ipfs.io) and [Filecoin](https://filecoin.io).**
6+
7+
When it comes down to building your next application, service, or website, web3.storage keeps it simple. You get all the benefits of decentralized storage technologies with the frictionless experience you expect in a modern dev workflow. **All you need to use web3.storage is an account and your data.**
8+
9+
## Getting Started
10+
11+
First, run the development server:
12+
13+
```bash
14+
pnpm dev
15+
```
16+
17+
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
18+
19+
Add pages as markdown with .md extension to the `src/pages/`
20+
21+
By default, the page map contains all .md and .mdx filenames and the directory structure, sorted alphabetically. Then, Nextra will use the title package to get formatted page names from filenames.
22+
23+
You can have an `_meta.json` file in each directory, and it will be used to override the default configuration of each page. It tells Nextra the order of each page, and the correct title.
24+
25+
```json
26+
{
27+
"index": "🏠",
28+
"w3cli": "Command line",
29+
"w3up-client": "JS Client",
30+
"concepts": "Concepts"
31+
}
32+
```
33+
34+
Built on next and nextra. See https://nextra.site/docs/guide/organize-files for more.

next.config.js

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
const withNextra = require('nextra')({
2+
theme: 'nextra-theme-docs',
3+
themeConfig: './src/theme.config.jsx'
4+
})
5+
6+
/** @type {import('next').NextConfig} */
7+
const nextConfig = {
8+
distDir: './out',
9+
output: 'export',
10+
images: { unoptimized: true },
11+
reactStrictMode: false,
12+
}
13+
14+
module.exports = withNextra(nextConfig)

package.json

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
{
2+
"name": "docs",
3+
"version": "0.1.0",
4+
"private": true,
5+
"scripts": {
6+
"dev": "next dev",
7+
"build": "next build",
8+
"start": "next start",
9+
"lint": "next lint"
10+
},
11+
"dependencies": {
12+
"next": "14.0.1",
13+
"nextra": "^2.13.2",
14+
"nextra-theme-docs": "^2.13.2",
15+
"react": "^18",
16+
"react-dom": "^18"
17+
},
18+
"devDependencies": {
19+
"@types/node": "^20",
20+
"@types/react": "^18",
21+
"@types/react-dom": "^18",
22+
"autoprefixer": "^10.0.1",
23+
"eslint": "^8",
24+
"eslint-config-next": "14.0.1",
25+
"postcss": "^8",
26+
"tailwindcss": "^3.3.0",
27+
"typescript": "^5"
28+
},
29+
"engines": {
30+
"node": ">=18"
31+
}
32+
}

0 commit comments

Comments
 (0)