diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..399af02 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +node_modules +.build +build +.DS_Store +.env +npm-debug.log* +yarn-error.log +**/.docusaurus diff --git a/.npmrc b/.npmrc new file mode 100644 index 0000000..7549542 --- /dev/null +++ b/.npmrc @@ -0,0 +1 @@ +registry=https://registry.npmmirror.com diff --git a/README.md b/README.md index 37036c6..cca0d83 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,76 @@ ---- -description: An overview to Lighthouse ---- - -# 👋 Introduction - - - -*** - -### What is Lighthouse? - -Lighthouse is a **permanent, decentralized storage protocol** powered by **Filecoin and IPFS**.\ -It allows individuals, developers, and enterprises to store data **forever** with a simple, one-time payment model—eliminating recurring cloud costs while ensuring verifiable, tamper-proof security. - -With Lighthouse, your files are stored across a decentralized network of Filecoin miners and can be accessed anytime through **dedicated IPFS gateways** optimized for speed, media delivery, and scalability. - -*** - -### Why Lighthouse? - -* **Perpetual Storage**\ - Pay once and preserve your files permanently without renewals. -* **Decentralized Security**\ - Your data is stored on IPFS + Filecoin, ensuring immutability and reliability. -* **Encryption & Access Control**\ - Use **Kavach Threshold Encryption** and token-gating to keep data private and grant access via tokens, NFTs, passkeys, or zkTLS. -* **Dedicated IPFS Gateways**\ - Fast retrieval for files, including **4K video streaming** at scale. -* **Decentralized Image Resizing**\ - Optimize images on retrieval—save bandwidth without losing quality. -* **Flexible Payments**\ - Choose annual or lifetime plans, pay with credit/debit cards or on-chain tokens. -* **No Vendor Lock-In**\ - Retrieve and migrate data anytime with full user control. - -*** - -### Tools for Developers - -* **Lighthouse SDK** – Libraries, APIs, and docs to integrate decentralized storage into apps. -* **Lighthouse CLI** – Manage files directly from your terminal with simple commands. -* **Encryption SDK** – Easily secure and token-gate private files across chains and networks. - -*** - -### Expanding the Data Economy - -Lighthouse doesn’t just store data—it powers new ecosystems: - -* **Data DAOs** – Create decentralized organizations to preserve, govern, and monetize data. -* **AI Data Monetization** – Store datasets, apply access control, and enable AI model training. -* **Private Processing** – Compute over private data while keeping it encrypted. -* **Cross-Ecosystem Support** – Built for AI, DePIN, NFTs, gaming, L1/L2 blockchains, and more. - -*** - -### Backed by Trusted Partners - -Lighthouse is already integrated into leading ecosystems like **SingularityNet, Cardano, and OKContract**, and is trusted for secure storage in the **NFT, modular blockchain, and AI data markets**. - -*** - -### Why It Matters - -Traditional cloud providers rent your data back to you. Lighthouse redefines storage with **permanent, affordable, and verifiable solutions**, enabling the next generation of apps, DAOs, and AI systems to thrive on **secure and censorship-resistant infrastructure**. - -**With Lighthouse, your data doesn’t expire—it lives forever.** - -*** - -### IPFS and Filecoin - -While both IPFS (InterPlanetary File System) and Filecoin are pivotal technologies in decentralized storage, they serve distinct but complementary roles: - -* **IPFS**: A peer-to-peer hypermedia protocol designed to store and share files in a distributed file system. It uses content-addressing to uniquely identify each file in a global namespace, making it efficient for retrieving cached data and sharing files. -* **Filecoin**: A decentralized storage network that incentivizes storage providers and clients to offer and use storage space. While IPFS handles the distribution and retrieval of files, Filecoin ensures that those files are stored reliably over time through economic incentives. - -By leveraging IPFS with Filecoin underneath, Lighthouse leverages the strengths of both technologies: the efficient file retrieval, immutability of IPFS with the reliable, incentivized storage of Filecoin. This combination ensures low-cost, verifiable, and perpetual storage solutions. - -*** +# Lighthouse Docs (Docusaurus) + +This repository now uses [Docusaurus](https://docusaurus.io/) to render the Lighthouse documentation. + +## Getting started + +1. Install dependencies: + ```bash + npm install + ``` +2. Start a local dev server: + ```bash + npm run start + ``` + The site will open at http://localhost:3000/ with hot reloading. +3. Build a production bundle: + ```bash + npm run build + ``` +4. Preview the production build locally: + ```bash + npm run serve + ``` + +### Troubleshooting installs/builds + +- If `npm install` fails with a 403 from the registry, ensure any corporate proxy variables are unset (`npm config delete proxy` and `npm config delete https-proxy`) and retry. +- Set an explicit registry if needed: + ```bash + npm config set registry https://registry.npmjs.org + ``` +- Some environments block the default registry outright. You can also try the included `.npmrc` mirror (`https://registry.npmmirror.com`), but if the registry itself is blocked you will need network access to an allowed npm mirror before running `npm run build`. + +## Deploying to Vercel + +The repository already includes `vercel.json` with the correct defaults for Docusaurus. Use either the dashboard or the CLI: + +### Deploy from the Vercel dashboard (recommended) + +1. Create a new project and connect this Git repository. +2. In **Project Settings → General** set: + - **Framework Preset:** `Docusaurus` (or `Other` if unavailable) + - **Install Command:** `npm install` + - **Build Command:** `npm run build` + - **Output Directory:** `build` +3. Save the settings and trigger a new deployment. The site will be served from the URL shown in the Vercel dashboard and should match the `url` in `docusaurus.config.ts` (currently `https://lighthouse-docs.vercel.app`). + +### Deploy from the Vercel CLI (alternative) + +1. Install the Vercel CLI if needed: + ```bash + npm install -g vercel + ``` +2. Log in and link the project (requires a Vercel account): + ```bash + vercel login + vercel link + ``` +3. Deploy using the configuration in `vercel.json`: + ```bash + vercel --prod + ``` + The CLI will build the site, upload the `build/` directory, and print the production URL. + +## Project structure + +- `docs/` contains all documentation content (migrated from GitBook). +- `static/` holds static assets such as images and the site favicon. +- `src/pages/` and `src/css/` contain the homepage and styling overrides. +- `docusaurus.config.ts` and `sidebars.ts` configure the Docusaurus site. + +## Adding or updating docs + +1. Create or edit Markdown files inside `docs/`. +2. Update `sidebars.ts` to add new pages to the navigation. +3. Run `npm run start` to verify the pages render correctly. diff --git a/account-delegation.md b/docs/account-delegation.md similarity index 100% rename from account-delegation.md rename to docs/account-delegation.md diff --git a/concepts/glossary.md b/docs/concepts/glossary.md similarity index 100% rename from concepts/glossary.md rename to docs/concepts/glossary.md diff --git a/concepts/ipfs-cid-transition-to-v1.md b/docs/concepts/ipfs-cid-transition-to-v1.md similarity index 100% rename from concepts/ipfs-cid-transition-to-v1.md rename to docs/concepts/ipfs-cid-transition-to-v1.md diff --git a/filecoin-first/deal-verification.md b/docs/filecoin-first/deal-verification.md similarity index 100% rename from filecoin-first/deal-verification.md rename to docs/filecoin-first/deal-verification.md diff --git a/filecoin-first/pay-per-deal.md b/docs/filecoin-first/pay-per-deal.md similarity index 100% rename from filecoin-first/pay-per-deal.md rename to docs/filecoin-first/pay-per-deal.md diff --git a/filecoin-first/podsi.md b/docs/filecoin-first/podsi.md similarity index 96% rename from filecoin-first/podsi.md rename to docs/filecoin-first/podsi.md index f7347c9..5b7b15c 100644 --- a/filecoin-first/podsi.md +++ b/docs/filecoin-first/podsi.md @@ -6,7 +6,7 @@ hidden: true **Proof of Data Segment Inclusion (PoDSI)** is like a certificate of authenticity. It assures that your file is safely tucked inside a special package, known as a "deal", made by the Lighthouse Node. This node combines several files, gives them a unique ID, offers proof of their inclusion, and even throws a mini-proof of the entire package's structure. -
+
{% hint style="warning" %} The time between uploading and being able to get your PoDSI varies from testnet from mainnet. Ideally it would be 6hr in testnet and 1 day in mainnet. You can get the PoDSI for your file by calling the `getProof` function in one of the following ways: diff --git a/filecoin-first/section-a.md b/docs/filecoin-first/section-a.md similarity index 100% rename from filecoin-first/section-a.md rename to docs/filecoin-first/section-a.md diff --git a/filecoin-first/section-b.md b/docs/filecoin-first/section-b.md similarity index 100% rename from filecoin-first/section-b.md rename to docs/filecoin-first/section-b.md diff --git a/filecoin-first/self-hosted-raas.md b/docs/filecoin-first/self-hosted-raas.md similarity index 96% rename from filecoin-first/self-hosted-raas.md rename to docs/filecoin-first/self-hosted-raas.md index 504b878..7f04d73 100644 --- a/filecoin-first/self-hosted-raas.md +++ b/docs/filecoin-first/self-hosted-raas.md @@ -14,7 +14,7 @@ Start an instance of the self-hosted RaaS by deploying a contract that inherits The [RaaS Starter Kit](https://github.com/filecoin-project/raas-starter-kit) comes with a frontend that allows you to upload your file to Lighthouse, get a CID for the uploaded file, then seamlessly submit the CID to the smart contract (accessible via `yarn start`). -![RaaS Starter Kit Frontend](../.gitbook/assets/Frontend.png) +![RaaS Starter Kit Frontend](/img/Frontend.png) If you're hosting your own RaaS service (specifically, the one in the [RaaS Starter Kit](https://github.com/filecoin-project/raas-starter-kit)), there's an event listener inside that you can use to listen for new deal requests. diff --git a/filecoin-first/usage.md b/docs/filecoin-first/usage.md similarity index 100% rename from filecoin-first/usage.md rename to docs/filecoin-first/usage.md diff --git a/how-to/ai/README.md b/docs/how-to/ai/index.md similarity index 100% rename from how-to/ai/README.md rename to docs/how-to/ai/index.md diff --git a/how-to/ai/mcp-protocol.md b/docs/how-to/ai/mcp-protocol.md similarity index 100% rename from how-to/ai/mcp-protocol.md rename to docs/how-to/ai/mcp-protocol.md diff --git a/how-to/check-for-filecoin-deals.md b/docs/how-to/check-for-filecoin-deals.md similarity index 100% rename from how-to/check-for-filecoin-deals.md rename to docs/how-to/check-for-filecoin-deals.md diff --git a/how-to/create-a-datacoin.md b/docs/how-to/create-a-datacoin.md similarity index 82% rename from how-to/create-a-datacoin.md rename to docs/how-to/create-a-datacoin.md index e4b77d0..bc9b628 100644 --- a/how-to/create-a-datacoin.md +++ b/docs/how-to/create-a-datacoin.md @@ -16,7 +16,7 @@ In short: **DataCoins turn raw data into a tradable, liquid asset.** ### **Step 1: Connect Wallet** -
+
Connect wallet and click on create data coin. @@ -24,7 +24,7 @@ Connect wallet and click on create data coin. ### **Step 2: Enter Personal Information** -
+
Fill out the form with the following details: @@ -40,7 +40,7 @@ The website link should point to your **DataDAO app**, which defines the logic f ### **Step 3: Add Social Information** -
+
Provide your social links such as **Telegram, Farcaster, X, GitHub, and LinkedIn**. @@ -50,7 +50,7 @@ All fields are optional—you can fill in whichever ones you prefer. ### **Step 4: Configure Tokenomics** of your choice. -
+
Set up the economics of your data coin: @@ -76,7 +76,7 @@ Once configured, click **Submit Data Coin**. Two transactions will follow: ### **Step 5: View and Manage Your Coin** -
+
After successful creation, you’ll be able to view your coin’s details. diff --git a/how-to/create-an-api-key.md b/docs/how-to/create-an-api-key.md similarity index 100% rename from how-to/create-an-api-key.md rename to docs/how-to/create-an-api-key.md diff --git a/how-to/delete-file.md b/docs/how-to/delete-file.md similarity index 100% rename from how-to/delete-file.md rename to docs/how-to/delete-file.md diff --git a/how-to/encryption-features/access-control-conditions.md b/docs/how-to/encryption-features/access-control-conditions.md similarity index 100% rename from how-to/encryption-features/access-control-conditions.md rename to docs/how-to/encryption-features/access-control-conditions.md diff --git a/how-to/encryption-features/access-control-node.md b/docs/how-to/encryption-features/access-control-node.md similarity index 100% rename from how-to/encryption-features/access-control-node.md rename to docs/how-to/encryption-features/access-control-node.md diff --git a/how-to/encryption-features/access-control-with-zktls.md b/docs/how-to/encryption-features/access-control-with-zktls.md similarity index 100% rename from how-to/encryption-features/access-control-with-zktls.md rename to docs/how-to/encryption-features/access-control-with-zktls.md diff --git a/how-to/encryption-features/account-delegation-tutorial.md b/docs/how-to/encryption-features/account-delegation-tutorial.md similarity index 100% rename from how-to/encryption-features/account-delegation-tutorial.md rename to docs/how-to/encryption-features/account-delegation-tutorial.md diff --git a/how-to/encryption-features/chains-supported.md b/docs/how-to/encryption-features/chains-supported.md similarity index 100% rename from how-to/encryption-features/chains-supported.md rename to docs/how-to/encryption-features/chains-supported.md diff --git a/how-to/encryption-features/decrypt-file/decrypt-file.md b/docs/how-to/encryption-features/decrypt-file/decrypt-file.md similarity index 100% rename from how-to/encryption-features/decrypt-file/decrypt-file.md rename to docs/how-to/encryption-features/decrypt-file/decrypt-file.md diff --git a/how-to/encryption-features/decrypt-file/README.md b/docs/how-to/encryption-features/decrypt-file/index.md similarity index 100% rename from how-to/encryption-features/decrypt-file/README.md rename to docs/how-to/encryption-features/decrypt-file/index.md diff --git a/how-to/encryption-features/decrypt-file/nodejs-decrypt-file.md b/docs/how-to/encryption-features/decrypt-file/nodejs-decrypt-file.md similarity index 100% rename from how-to/encryption-features/decrypt-file/nodejs-decrypt-file.md rename to docs/how-to/encryption-features/decrypt-file/nodejs-decrypt-file.md diff --git a/how-to/encryption-features/get-access-conditions.md b/docs/how-to/encryption-features/get-access-conditions.md similarity index 100% rename from how-to/encryption-features/get-access-conditions.md rename to docs/how-to/encryption-features/get-access-conditions.md diff --git a/how-to/encryption-features/README.md b/docs/how-to/encryption-features/index.md similarity index 100% rename from how-to/encryption-features/README.md rename to docs/how-to/encryption-features/index.md diff --git a/how-to/encryption-features/revoke-access.md b/docs/how-to/encryption-features/revoke-access.md similarity index 100% rename from how-to/encryption-features/revoke-access.md rename to docs/how-to/encryption-features/revoke-access.md diff --git a/how-to/encryption-features/share-file.md b/docs/how-to/encryption-features/share-file.md similarity index 100% rename from how-to/encryption-features/share-file.md rename to docs/how-to/encryption-features/share-file.md diff --git a/how-to/file-info.md b/docs/how-to/file-info.md similarity index 100% rename from how-to/file-info.md rename to docs/how-to/file-info.md diff --git a/how-to/get-balance.md b/docs/how-to/get-balance.md similarity index 100% rename from how-to/get-balance.md rename to docs/how-to/get-balance.md diff --git a/how-to/ipns-handle-mutable-data.md b/docs/how-to/ipns-handle-mutable-data.md similarity index 100% rename from how-to/ipns-handle-mutable-data.md rename to docs/how-to/ipns-handle-mutable-data.md diff --git a/how-to/list-files.md b/docs/how-to/list-files.md similarity index 100% rename from how-to/list-files.md rename to docs/how-to/list-files.md diff --git a/how-to/migrations/google-drive.md b/docs/how-to/migrations/google-drive.md similarity index 100% rename from how-to/migrations/google-drive.md rename to docs/how-to/migrations/google-drive.md diff --git a/how-to/migrations/README.md b/docs/how-to/migrations/index.md similarity index 100% rename from how-to/migrations/README.md rename to docs/how-to/migrations/index.md diff --git a/how-to/migrations/ipfs-provider.md b/docs/how-to/migrations/ipfs-provider.md similarity index 86% rename from how-to/migrations/ipfs-provider.md rename to docs/how-to/migrations/ipfs-provider.md index aee5695..88af032 100644 --- a/how-to/migrations/ipfs-provider.md +++ b/docs/how-to/migrations/ipfs-provider.md @@ -18,7 +18,7 @@ Navigate to [Files Dapp](https://files.lighthouse.storage/) and either register Click on the `migration` option in the left panel. -
+
### Step 3: Create a New Migration @@ -32,7 +32,7 @@ Select the `Create Migration` button to start the process. Enter the CID (Content Identifier) for your content. Alternatively, if you have multiple CIDs, you can upload a CSV file with all the CIDs listed. -
+
### Step 5: Execute Migration diff --git a/how-to/overview.md b/docs/how-to/overview.md similarity index 94% rename from how-to/overview.md rename to docs/how-to/overview.md index 189adc2..ab93b24 100644 --- a/how-to/overview.md +++ b/docs/how-to/overview.md @@ -49,7 +49,7 @@ The following commands are available with the Lighthouse CLI tool :frame\_photo:**CLI Commands** -
+
## Go SDK CLI Tool @@ -159,4 +159,4 @@ Run the following command to see all available commands: lhctl --help ``` -
+
diff --git a/how-to/pay-per-use.md b/docs/how-to/pay-per-use.md similarity index 100% rename from how-to/pay-per-use.md rename to docs/how-to/pay-per-use.md diff --git a/how-to/pin-cid.md b/docs/how-to/pin-cid.md similarity index 100% rename from how-to/pin-cid.md rename to docs/how-to/pin-cid.md diff --git a/how-to/resize-image.md b/docs/how-to/resize-image.md similarity index 100% rename from how-to/resize-image.md rename to docs/how-to/resize-image.md diff --git a/how-to/retrieve-file.md b/docs/how-to/retrieve-file.md similarity index 100% rename from how-to/retrieve-file.md rename to docs/how-to/retrieve-file.md diff --git a/how-to/upload-data/buffer.md b/docs/how-to/upload-data/buffer.md similarity index 100% rename from how-to/upload-data/buffer.md rename to docs/how-to/upload-data/buffer.md diff --git a/how-to/upload-data/file.md b/docs/how-to/upload-data/file.md similarity index 100% rename from how-to/upload-data/file.md rename to docs/how-to/upload-data/file.md diff --git a/docs/how-to/upload-data/index.md b/docs/how-to/upload-data/index.md new file mode 100644 index 0000000..6b81336 --- /dev/null +++ b/docs/how-to/upload-data/index.md @@ -0,0 +1,12 @@ +# 🔼 Upload Data + +This section covers the steps to upload a file to Lighthouse. You can upload a file, buffer, or text/JSON payload. + +1. [Upload File](file.md) +2. [Upload Text/JSON](text-json.md) +3. [Upload Buffer](buffer.md) + +> Looking for Filecoin Virtual Machine workflows? Use the Filecoin Virtual Machine interface as shown below when you need on-chain execution alongside Lighthouse storage. + +![Uploading via FVM](/img/Screenshot 2023-10-21 at 10.39.34 AM.png) + diff --git a/how-to/upload-data/text-json.md b/docs/how-to/upload-data/text-json.md similarity index 100% rename from how-to/upload-data/text-json.md rename to docs/how-to/upload-data/text-json.md diff --git a/how-to/upload-encrypted-data/file.md b/docs/how-to/upload-encrypted-data/file.md similarity index 100% rename from how-to/upload-encrypted-data/file.md rename to docs/how-to/upload-encrypted-data/file.md diff --git a/how-to/upload-encrypted-data/README.md b/docs/how-to/upload-encrypted-data/index.md similarity index 100% rename from how-to/upload-encrypted-data/README.md rename to docs/how-to/upload-encrypted-data/index.md diff --git a/how-to/upload-encrypted-data/kavach-encryption-authentication/README.md b/docs/how-to/upload-encrypted-data/kavach-encryption-authentication/index.md similarity index 100% rename from how-to/upload-encrypted-data/kavach-encryption-authentication/README.md rename to docs/how-to/upload-encrypted-data/kavach-encryption-authentication/index.md diff --git a/how-to/upload-encrypted-data/kavach-encryption-authentication/method-1-signed-message.md b/docs/how-to/upload-encrypted-data/kavach-encryption-authentication/method-1-signed-message.md similarity index 100% rename from how-to/upload-encrypted-data/kavach-encryption-authentication/method-1-signed-message.md rename to docs/how-to/upload-encrypted-data/kavach-encryption-authentication/method-1-signed-message.md diff --git a/how-to/upload-encrypted-data/kavach-encryption-authentication/method-2-jwt.md b/docs/how-to/upload-encrypted-data/kavach-encryption-authentication/method-2-jwt.md similarity index 100% rename from how-to/upload-encrypted-data/kavach-encryption-authentication/method-2-jwt.md rename to docs/how-to/upload-encrypted-data/kavach-encryption-authentication/method-2-jwt.md diff --git a/how-to/upload-encrypted-data/kavach-encryption-authentication/method-3-passkey.md b/docs/how-to/upload-encrypted-data/kavach-encryption-authentication/method-3-passkey.md similarity index 100% rename from how-to/upload-encrypted-data/kavach-encryption-authentication/method-3-passkey.md rename to docs/how-to/upload-encrypted-data/kavach-encryption-authentication/method-3-passkey.md diff --git a/how-to/upload-encrypted-data/text-json.md b/docs/how-to/upload-encrypted-data/text-json.md similarity index 100% rename from how-to/upload-encrypted-data/text-json.md rename to docs/how-to/upload-encrypted-data/text-json.md diff --git a/how-to/using-pdp-with-lighthouse.md b/docs/how-to/using-pdp-with-lighthouse.md similarity index 100% rename from how-to/using-pdp-with-lighthouse.md rename to docs/how-to/using-pdp-with-lighthouse.md diff --git a/interacting-with-node/web-sockets.md b/docs/interacting-with-node/web-sockets.md similarity index 100% rename from interacting-with-node/web-sockets.md rename to docs/interacting-with-node/web-sockets.md diff --git a/interacting-with-smart-contracts/code-examples.md b/docs/interacting-with-smart-contracts/code-examples.md similarity index 100% rename from interacting-with-smart-contracts/code-examples.md rename to docs/interacting-with-smart-contracts/code-examples.md diff --git a/interacting-with-smart-contracts/key-functions.md b/docs/interacting-with-smart-contracts/key-functions.md similarity index 100% rename from interacting-with-smart-contracts/key-functions.md rename to docs/interacting-with-smart-contracts/key-functions.md diff --git a/docs/intro.md b/docs/intro.md new file mode 100644 index 0000000..5c566f0 --- /dev/null +++ b/docs/intro.md @@ -0,0 +1,83 @@ +--- +title: Introduction +description: An overview to Lighthouse +slug: / +--- + +# 👋 Introduction + + + +*** + +### What is Lighthouse? + +Lighthouse is a **permanent, decentralized storage protocol** powered by **Filecoin and IPFS**.\ +It allows individuals, developers, and enterprises to store data **forever** with a simple, one-time payment model—eliminating recurring cloud costs while ensuring verifiable, tamper-proof security. + +With Lighthouse, your files are stored across a decentralized network of Filecoin miners and can be accessed anytime through **dedicated IPFS gateways** optimized for speed, media delivery, and scalability. + +*** + +### Why Lighthouse? + +* **Perpetual Storage**\ + Pay once and preserve your files permanently without renewals. +* **Decentralized Security**\ + Your data is stored on IPFS + Filecoin, ensuring immutability and reliability. +* **Encryption & Access Control**\ + Use **Kavach Threshold Encryption** and token-gating to keep data private and grant access via tokens, NFTs, passkeys, or zkTLS. +* **Dedicated IPFS Gateways**\ + Fast retrieval for files, including **4K video streaming** at scale. +* **Decentralized Image Resizing**\ + Optimize images on retrieval—save bandwidth without losing quality. +* **Flexible Payments**\ + Choose annual or lifetime plans, pay with credit/debit cards or on-chain tokens. +* **No Vendor Lock-In**\ + Retrieve and migrate data anytime with full user control. + +*** + +### Tools for Developers + +* **Lighthouse SDK** – Libraries, APIs, and docs to integrate decentralized storage into apps. +* **Lighthouse CLI** – Manage files directly from your terminal with simple commands. +* **Encryption SDK** – Easily secure and token-gate private files across chains and networks. + +*** + +### Expanding the Data Economy + +Lighthouse doesn’t just store data—it powers new ecosystems: + +* **Data DAOs** – Create decentralized organizations to preserve, govern, and monetize data. +* **AI Data Monetization** – Store datasets, apply access control, and enable AI model training. +* **Private Processing** – Compute over private data while keeping it encrypted. +* **Cross-Ecosystem Support** – Built for AI, DePIN, NFTs, gaming, L1/L2 blockchains, and more. + +*** + +### Backed by Trusted Partners + +Lighthouse is already integrated into leading ecosystems like **SingularityNet, Cardano, and OKContract**, and is trusted for secure storage in the **NFT, modular blockchain, and AI data markets**. + +*** + +### Why It Matters + +Traditional cloud providers rent your data back to you. Lighthouse redefines storage with **permanent, affordable, and verifiable solutions**, enabling the next generation of apps, DAOs, and AI systems to thrive on **secure and censorship-resistant infrastructure**. + +**With Lighthouse, your data doesn’t expire—it lives forever.** + +*** + +### IPFS and Filecoin + +While both IPFS (InterPlanetary File System) and Filecoin are pivotal technologies in decentralized storage, they serve distinct but complementary roles: + +* **IPFS**: A peer-to-peer hypermedia protocol designed to store and share files in a distributed file system. It uses content-addressing to uniquely identify each file in a global namespace, making it efficient for retrieving cached data and sharing files. +* **Filecoin**: A decentralized storage network that incentivizes storage providers and clients to offer and use storage space. While IPFS handles the distribution and retrieval of files, Filecoin ensures that those files are stored reliably over time through economic incentives. + +By leveraging IPFS with Filecoin underneath, Lighthouse leverages the strengths of both technologies: the efficient file retrieval, immutability of IPFS with the reliable, incentivized storage of Filecoin. This combination ensures low-cost, verifiable, and perpetual storage solutions. + +*** diff --git a/javascript/functions/add-cid.md b/docs/javascript/functions/add-cid.md similarity index 100% rename from javascript/functions/add-cid.md rename to docs/javascript/functions/add-cid.md diff --git a/javascript/functions/get-encryption-keypair.md b/docs/javascript/functions/get-encryption-keypair.md similarity index 100% rename from javascript/functions/get-encryption-keypair.md rename to docs/javascript/functions/get-encryption-keypair.md diff --git a/quick-start.md b/docs/quick-start.md similarity index 89% rename from quick-start.md rename to docs/quick-start.md index f6db173..7227be5 100644 --- a/quick-start.md +++ b/docs/quick-start.md @@ -1,4 +1,5 @@ --- +title: Quick Start icon: hammer --- @@ -6,11 +7,11 @@ icon: hammer In this section, we will see how to -1. [Create an API Key](quick-start.md#create-an-api-key) -2. [Upload a file](quick-start.md#upload-a-file) -3. [View the file](quick-start.md#view-file) -4. [Get Filecoin deals](quick-start.md#get-filecoin-deal) -5. [What's Next?](quick-start.md#id-5.-whats-next) +1. [Create an API Key](#create-an-api-key) +2. [Upload a file](#upload-a-file) +3. [View the file](#view-file) +4. [Get Filecoin deals](#get-filecoin-deal) +5. [What's Next?](#id-5.-whats-next) This Quick Start guide walks you through the essentials: creating an API key, uploading a file, viewing it, and tracking its storage status. While the examples below use Node.js, you can easily adapt them for other environments using our How-To section @@ -26,7 +27,7 @@ This Quick Start guide walks you through the essentials: creating an API key, up You can also generate the API key from CLI {% endhint %} -
+
### 2. Upload a File diff --git a/support/contact.md b/docs/support/contact.md similarity index 100% rename from support/contact.md rename to docs/support/contact.md diff --git a/tutorials/create-pay-to-view-media.md b/docs/tutorials/create-pay-to-view-media.md similarity index 91% rename from tutorials/create-pay-to-view-media.md rename to docs/tutorials/create-pay-to-view-media.md index 807a1c1..83335e8 100644 --- a/tutorials/create-pay-to-view-media.md +++ b/docs/tutorials/create-pay-to-view-media.md @@ -6,7 +6,7 @@ description: >- # đź’¸ Pay to View Application -**Step 1:** The user uploads an encrypted file to the Lighthouse IPFS node. Refer to this NodeJS [Encryption Upload](broken-reference) or ReactJS [Browser Encryption Upload](broken-reference) code example**.** +**Step 1:** The user uploads an encrypted file to the Lighthouse IPFS node. Refer to the NodeJS encryption upload or ReactJS browser encryption upload code examples in the SDK documentation.**.** Lighthouse node returns an IPFS CID/Hash for the encrypted file. diff --git a/tutorials/document-verification-with-podsi.md b/docs/tutorials/document-verification-with-podsi.md similarity index 90% rename from tutorials/document-verification-with-podsi.md rename to docs/tutorials/document-verification-with-podsi.md index cd5c870..3721e0a 100644 --- a/tutorials/document-verification-with-podsi.md +++ b/docs/tutorials/document-verification-with-podsi.md @@ -42,23 +42,23 @@ PoDSI is a proof mechanism that confirms a specific piece of data is included an 1. Go on [https://files.lighthouse.storage/](https://files.lighthouse.storage/) and Click on Login -
+
2. Select any of the login method and perform verification steps -
+
3. Click on API Key on the left side panel on the dashboard. -
+
4. Insert name for your API -
+
5. Copy the API Key -
+
*** diff --git a/tutorials/minting-nfts-on-evm-chains.md b/docs/tutorials/minting-nfts-on-evm-chains.md similarity index 100% rename from tutorials/minting-nfts-on-evm-chains.md rename to docs/tutorials/minting-nfts-on-evm-chains.md diff --git a/tutorials/minting-nfts-on-solana.md b/docs/tutorials/minting-nfts-on-solana.md similarity index 100% rename from tutorials/minting-nfts-on-solana.md rename to docs/tutorials/minting-nfts-on-solana.md diff --git a/tutorials/programmable-storage-with-lighthouse-sdk-and-filecoin.md b/docs/tutorials/programmable-storage-with-lighthouse-sdk-and-filecoin.md similarity index 100% rename from tutorials/programmable-storage-with-lighthouse-sdk-and-filecoin.md rename to docs/tutorials/programmable-storage-with-lighthouse-sdk-and-filecoin.md diff --git a/tutorials/pushing-file-metadata-onchain.md b/docs/tutorials/pushing-file-metadata-onchain.md similarity index 100% rename from tutorials/pushing-file-metadata-onchain.md rename to docs/tutorials/pushing-file-metadata-onchain.md diff --git a/tutorials/secure-file-sharing.md b/docs/tutorials/secure-file-sharing.md similarity index 100% rename from tutorials/secure-file-sharing.md rename to docs/tutorials/secure-file-sharing.md diff --git a/tutorials/token-gating-and-custom-contract.md b/docs/tutorials/token-gating-and-custom-contract.md similarity index 100% rename from tutorials/token-gating-and-custom-contract.md rename to docs/tutorials/token-gating-and-custom-contract.md diff --git a/tutorials/token-gating-nfts.md b/docs/tutorials/token-gating-nfts.md similarity index 100% rename from tutorials/token-gating-nfts.md rename to docs/tutorials/token-gating-nfts.md diff --git a/tutorials/update-content-with-lighthouse-ipns/README.md b/docs/tutorials/update-content-with-lighthouse-ipns/index.md similarity index 83% rename from tutorials/update-content-with-lighthouse-ipns/README.md rename to docs/tutorials/update-content-with-lighthouse-ipns/index.md index d9e26f1..0077576 100644 --- a/tutorials/update-content-with-lighthouse-ipns/README.md +++ b/docs/tutorials/update-content-with-lighthouse-ipns/index.md @@ -1,6 +1,6 @@ --- description: A Comprehensive Guide to Publishing and Updating Content with Lighthouse IPNS -cover: ../../.gitbook/assets/IPNS_8.png +cover: /img/IPNS_8.png coverY: 0 --- @@ -36,23 +36,23 @@ _**Note: Skip to**_ [#store-and-update-content-on-ipns-using-lighthouse](./#stor 1. Go on [https://files.lighthouse.storage/](https://files.lighthouse.storage/) and Click on Login -
+
2. Select any of the login method and perform verification steps -
+
3. Click on API Key on the left side panel on the dashboard. -
+
4. Insert name for your API -
+
5. Copy the API Key -
+
## Store and Update content on IPNS using Lighthouse @@ -66,7 +66,7 @@ _**Note: Skip to**_ [#store-and-update-content-on-ipns-using-lighthouse](./#stor This command will return an IPNS name and ID, which we will use later to publish the content. -
+
@@ -84,7 +84,7 @@ _**Note: Skip to**_ [#store-and-update-content-on-ipns-using-lighthouse](./#stor lighthouse-web3 upload ./text.txt ``` -
+
@@ -96,7 +96,7 @@ _**Note: Skip to**_ [#store-and-update-content-on-ipns-using-lighthouse](./#stor You will receive a link that can be used to access the published content. This link will remain valid even if the content's IPFS hash changes. -
+
#### **Updating CID:** @@ -114,7 +114,7 @@ _**Note: Skip to**_ [#store-and-update-content-on-ipns-using-lighthouse](./#stor lighthouse-web3 upload ./text2.txt ``` -
+
@@ -134,7 +134,7 @@ lighthouse-web3 ipns --list This will display a list of IPNS records with their corresponding keys and CIDs. -
+
**Remove** an IPNS record: @@ -144,7 +144,7 @@ lighthouse-web3 ipns --remove 8f4f116282a24cec99bcad73a317a3f4 This step allows you to remove an IPNS record if needed. -
+
### **Method 2: Using Node.js** diff --git a/tutorials/update-content-with-lighthouse-ipns/using-go-sdk.md b/docs/tutorials/update-content-with-lighthouse-ipns/using-go-sdk.md similarity index 100% rename from tutorials/update-content-with-lighthouse-ipns/using-go-sdk.md rename to docs/tutorials/update-content-with-lighthouse-ipns/using-go-sdk.md diff --git a/tutorials/update-content-with-lighthouse-ipns/using-node.js-sdk.md b/docs/tutorials/update-content-with-lighthouse-ipns/using-node.js-sdk.md similarity index 100% rename from tutorials/update-content-with-lighthouse-ipns/using-node.js-sdk.md rename to docs/tutorials/update-content-with-lighthouse-ipns/using-node.js-sdk.md diff --git a/tutorials/upload-encrypted-files.md b/docs/tutorials/upload-encrypted-files.md similarity index 100% rename from tutorials/upload-encrypted-files.md rename to docs/tutorials/upload-encrypted-files.md diff --git a/tutorials/use-go-sdk.md b/docs/tutorials/use-go-sdk.md similarity index 95% rename from tutorials/use-go-sdk.md rename to docs/tutorials/use-go-sdk.md index 51ca938..6111aa8 100644 --- a/tutorials/use-go-sdk.md +++ b/docs/tutorials/use-go-sdk.md @@ -1,7 +1,7 @@ --- description: Getting Started with Lighthouse Go SDK - Store Files Permanently icon: g -cover: ../.gitbook/assets/go-banner.png +cover: /img/go-banner.png coverY: 0 --- @@ -29,23 +29,23 @@ _**Note: If you already have Lighthouse API key, skip Step 0 and go to**_ [#step 1. Go on [https://files.lighthouse.storage/](https://files.lighthouse.storage/) and Click on Login -
+
2. Select any of the login method and perform verification steps -
+
3. Click on API Key on the left side panel on the dashboard. -
+
4. Insert name for your API -
+
5. Copy the API Key -
+
*** diff --git a/tutorials/use-python-sdk.md b/docs/tutorials/use-python-sdk.md similarity index 90% rename from tutorials/use-python-sdk.md rename to docs/tutorials/use-python-sdk.md index 21b2fb7..0f2fe76 100644 --- a/tutorials/use-python-sdk.md +++ b/docs/tutorials/use-python-sdk.md @@ -1,7 +1,7 @@ --- description: Getting Started with Lighthouse Python SDK - Store Files Permanently icon: python -cover: ../.gitbook/assets/Python_6 (1).png +cover: /img/Python_6 (1).png coverY: 0 --- @@ -29,23 +29,23 @@ _**Note: If you already have Lighthouse API key, skip Step 0 and go to**_ [#step 1. Go on [https://files.lighthouse.storage/](https://files.lighthouse.storage/) and Click on Login -
+
2. Select any of the login method and perform verification steps -
+
3. Click on API Key on the left side panel on the dashboard. -
+
4. Insert name for your API -
+
5. Copy the API Key -
+
*** diff --git a/tutorials/use-radix-wallet-on-lighthouse-filesdapp.md b/docs/tutorials/use-radix-wallet-on-lighthouse-filesdapp.md similarity index 93% rename from tutorials/use-radix-wallet-on-lighthouse-filesdapp.md rename to docs/tutorials/use-radix-wallet-on-lighthouse-filesdapp.md index f161b3c..228e73c 100644 --- a/tutorials/use-radix-wallet-on-lighthouse-filesdapp.md +++ b/docs/tutorials/use-radix-wallet-on-lighthouse-filesdapp.md @@ -23,7 +23,7 @@ icon: square-root * Upon successful login, users can access all Lighthouse features as described below.\ -
+
2. **Features Accessible After Login** \ @@ -34,7 +34,7 @@ icon: square-root * **Generate API** **Keys**: Generate API keys for programmatic access to Lighthouse features.\ -
+
3. **Using the Encryption Module (Lighthouse Kavach)**\ \ To access Lighthouse’s **encryption module** for advanced file management, users must generate a **JWT key** by signing an authentication message via their Radix Mobile Wallet.\ @@ -51,7 +51,7 @@ icon: square-root - + diff --git a/tutorials/video-player.md b/docs/tutorials/video-player.md similarity index 100% rename from tutorials/video-player.md rename to docs/tutorials/video-player.md diff --git a/tutorials/x402-pay-per-use-file-upload.md b/docs/tutorials/x402-pay-per-use-file-upload.md similarity index 100% rename from tutorials/x402-pay-per-use-file-upload.md rename to docs/tutorials/x402-pay-per-use-file-upload.md diff --git a/zktls.md b/docs/zktls.md similarity index 100% rename from zktls.md rename to docs/zktls.md diff --git a/docusaurus.config.ts b/docusaurus.config.ts new file mode 100644 index 0000000..4a9e7b0 --- /dev/null +++ b/docusaurus.config.ts @@ -0,0 +1,103 @@ +import type {Config} from '@docusaurus/types'; +import {themes as prismThemes} from 'prism-react-renderer'; + +const config: Config = { + title: 'Lighthouse Docs', + tagline: 'Permanent, decentralized storage protocol documentation', + favicon: 'img/favicon.svg', + + url: 'https://lighthouse-docs.vercel.app', + baseUrl: '/', + + organizationName: 'lighthouse-web3', + projectName: 'docs', + + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', + + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + presets: [ + [ + 'classic', + { + docs: { + routeBasePath: '/', + sidebarPath: './sidebars.ts', + }, + blog: false, + theme: { + customCss: './src/css/custom.css', + }, + }, + ], + ], + + themeConfig: { + navbar: { + title: 'Lighthouse Docs', + logo: { + alt: 'Lighthouse logo', + src: 'img/favicon.svg', + }, + items: [ + {type: 'doc', docId: 'intro', position: 'left', label: 'Docs'}, + { + href: 'https://github.com/lighthouse-web3', + label: 'GitHub', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'Docs', + items: [ + { + label: 'Introduction', + to: '/', + }, + { + label: 'Quick Start', + to: '/quick-start', + }, + ], + }, + { + title: 'Community', + items: [ + { + label: 'GitHub Discussions', + href: 'https://github.com/lighthouse-web3/community/discussions', + }, + { + label: 'Twitter', + href: 'https://twitter.com/LighthouseWeb3', + }, + ], + }, + { + title: 'More', + items: [ + { + label: 'Lighthouse', + href: 'https://www.lighthouse.storage/', + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} Lighthouse. Built with Docusaurus.`, + }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + }, + }, +}; + +export default config; diff --git a/how-to/upload-data/README.md b/how-to/upload-data/README.md deleted file mode 100644 index 9a233dc..0000000 --- a/how-to/upload-data/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# 🔼 Upload Data - -This section covers the steps to upload a file to Lighthouse, three types of data can be uploaded file, buffer, and text/JSON. - -1. [Upload File](file.md) -2. [Upload Text/JSON](text-json.md) -3. [Upload Buffer](buffer.md) - - - -
Check this section to Upload via Filecoin Virtual MachineBroken linkScreenshot 2023-10-21 at 10.39.34 AM.pngBroken link
- diff --git a/package.json b/package.json new file mode 100644 index 0000000..98755e0 --- /dev/null +++ b/package.json @@ -0,0 +1,26 @@ +{ + "name": "lighthouse-docs", + "version": "0.0.0", + "private": true, + "scripts": { + "start": "docusaurus start", + "build": "docusaurus build", + "serve": "docusaurus serve", + "clear": "docusaurus clear", + "swizzle": "docusaurus swizzle" + }, + "dependencies": { + "@docusaurus/core": "^3.9.0", + "@docusaurus/preset-classic": "^3.9.0", + "@docusaurus/theme-classic": "^3.9.0", + "clsx": "^2.1.0", + "prism-react-renderer": "^2.3.0", + "react": "^18.2.0", + "react-dom": "^18.2.0" + }, + "devDependencies": { + "@docusaurus/module-type-aliases": "^3.9.0", + "@tsconfig/docusaurus": "^2.0.0", + "typescript": "^5.4.0" + } +} diff --git a/sidebars.ts b/sidebars.ts new file mode 100644 index 0000000..7bb63b2 --- /dev/null +++ b/sidebars.ts @@ -0,0 +1,174 @@ +import type {SidebarsConfig} from '@docusaurus/plugin-content-docs'; + +const sidebars: SidebarsConfig = { + docs: [ + 'intro', + 'quick-start', + { + type: 'category', + label: 'How To', + collapsed: false, + items: [ + 'how-to/create-an-api-key', + { + type: 'category', + label: 'Upload Data', + items: [ + 'how-to/upload-data/index', + 'how-to/upload-data/file', + 'how-to/upload-data/text-json', + 'how-to/upload-data/buffer', + ], + }, + { + type: 'category', + label: 'Upload Encrypted Data', + items: [ + 'how-to/upload-encrypted-data/index', + 'how-to/upload-encrypted-data/file', + 'how-to/upload-encrypted-data/text-json', + { + type: 'category', + label: 'Kavach Encryption Authentication', + items: [ + 'how-to/upload-encrypted-data/kavach-encryption-authentication/index', + 'how-to/upload-encrypted-data/kavach-encryption-authentication/method-1-signed-message', + 'how-to/upload-encrypted-data/kavach-encryption-authentication/method-2-jwt', + 'how-to/upload-encrypted-data/kavach-encryption-authentication/method-3-passkey', + ], + }, + ], + }, + { + type: 'category', + label: 'Encryption Features', + items: [ + 'how-to/encryption-features/index', + 'how-to/encryption-features/share-file', + 'how-to/encryption-features/revoke-access', + 'how-to/encryption-features/get-access-conditions', + 'how-to/encryption-features/access-control-node', + 'how-to/encryption-features/chains-supported', + 'how-to/encryption-features/access-control-conditions', + { + type: 'category', + label: 'Decrypt File', + items: [ + 'how-to/encryption-features/decrypt-file/index', + 'how-to/encryption-features/decrypt-file/decrypt-file', + 'how-to/encryption-features/decrypt-file/nodejs-decrypt-file', + ], + }, + 'how-to/encryption-features/access-control-with-zktls', + 'how-to/encryption-features/account-delegation-tutorial', + ], + }, + 'how-to/list-files', + 'how-to/delete-file', + 'how-to/file-info', + 'how-to/create-a-datacoin', + 'how-to/using-pdp-with-lighthouse', + 'how-to/get-balance', + 'how-to/retrieve-file', + 'how-to/check-for-filecoin-deals', + 'how-to/ipns-handle-mutable-data', + { + type: 'category', + label: 'Migrations', + items: [ + 'how-to/migrations/index', + 'how-to/migrations/ipfs-provider', + 'how-to/migrations/google-drive', + ], + }, + 'how-to/pin-cid', + 'how-to/pay-per-use', + 'how-to/resize-image', + 'how-to/overview', + { + type: 'category', + label: 'AI', + items: ['how-to/ai/index', 'how-to/ai/mcp-protocol'], + }, + ], + }, + 'zktls', + 'account-delegation', + { + type: 'category', + label: 'Filecoin First', + items: [ + 'filecoin-first/usage', + 'filecoin-first/pay-per-deal', + 'filecoin-first/section-a', + 'filecoin-first/section-b', + 'filecoin-first/podsi', + 'filecoin-first/deal-verification', + 'filecoin-first/self-hosted-raas', + ], + }, + { + type: 'category', + label: 'Tutorials', + items: [ + 'tutorials/create-pay-to-view-media', + 'tutorials/use-python-sdk', + 'tutorials/use-go-sdk', + { + type: 'category', + label: 'Update Content with Lighthouse IPNS', + items: [ + 'tutorials/update-content-with-lighthouse-ipns/index', + 'tutorials/update-content-with-lighthouse-ipns/using-node.js-sdk', + 'tutorials/update-content-with-lighthouse-ipns/using-go-sdk', + ], + }, + 'tutorials/video-player', + 'tutorials/document-verification-with-podsi', + 'tutorials/minting-nfts-on-evm-chains', + 'tutorials/minting-nfts-on-solana', + 'tutorials/programmable-storage-with-lighthouse-sdk-and-filecoin', + 'tutorials/secure-file-sharing', + 'tutorials/upload-encrypted-files', + 'tutorials/token-gating-and-custom-contract', + 'tutorials/token-gating-nfts', + 'tutorials/pushing-file-metadata-onchain', + 'tutorials/use-radix-wallet-on-lighthouse-filesdapp', + 'tutorials/x402-pay-per-use-file-upload', + ], + }, + { + type: 'category', + label: 'Interacting with Smart Contracts', + items: [ + 'interacting-with-smart-contracts/key-functions', + 'interacting-with-smart-contracts/code-examples', + ], + }, + { + type: 'category', + label: 'Interacting with Node', + items: ['interacting-with-node/web-sockets'], + }, + { + type: 'category', + label: 'JavaScript Functions', + items: [ + 'javascript/functions/add-cid', + 'javascript/functions/get-encryption-keypair', + ], + }, + { + type: 'category', + label: 'Concepts', + items: ['concepts/glossary', 'concepts/ipfs-cid-transition-to-v1'], + }, + { + type: 'category', + label: 'Support', + items: ['support/contact'], + }, + ], +}; + +export default sidebars; diff --git a/src/css/custom.css b/src/css/custom.css new file mode 100644 index 0000000..7073514 --- /dev/null +++ b/src/css/custom.css @@ -0,0 +1,24 @@ +:root { + --ifm-color-primary: #3a7bd5; + --ifm-color-primary-dark: #336fbd; + --ifm-color-primary-darker: #2f66b1; + --ifm-color-primary-darkest: #265395; + --ifm-color-primary-light: #4e8de1; + --ifm-color-primary-lighter: #5c98e4; + --ifm-color-primary-lightest: #77aef0; + --ifm-code-font-size: 95%; +} + +[data-theme='dark'] { + --ifm-color-primary: #77aef0; + --ifm-color-primary-dark: #5c98e4; + --ifm-color-primary-darker: #4e8de1; + --ifm-color-primary-darkest: #3a7bd5; + --ifm-color-primary-light: #9ac4f5; + --ifm-color-primary-lighter: #b0d2f8; + --ifm-color-primary-lightest: #d1e6fb; +} + +img { + border-radius: 6px; +} diff --git a/src/pages/index.module.css b/src/pages/index.module.css new file mode 100644 index 0000000..c2d5530 --- /dev/null +++ b/src/pages/index.module.css @@ -0,0 +1,47 @@ +.heroBanner { + padding: 4rem 0; + text-align: center; + background: linear-gradient(135deg, #0c1c3f 0%, #1d3b73 50%, #0c1c3f 100%); + color: var(--ifm-color-white); +} + +.heroTitle { + font-size: clamp(2.5rem, 4vw, 3.5rem); + margin-bottom: 1rem; +} + +.heroSubtitle { + font-size: 1.125rem; + max-width: 760px; + margin: 0 auto 2rem auto; + color: rgba(255, 255, 255, 0.8); +} + +.buttons { + display: flex; + justify-content: center; + gap: 1rem; + flex-wrap: wrap; +} + +.grid { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(240px, 1fr)); + gap: 1.5rem; +} + +.card { + padding: 1.5rem; + border: 1px solid var(--ifm-color-emphasis-200); + border-radius: 12px; + background-color: var(--ifm-background-surface-color); + box-shadow: 0 8px 24px rgba(0, 0, 0, 0.05); +} + +.card h3 { + margin-bottom: 0.5rem; +} + +.card p { + margin-bottom: 0.75rem; +} diff --git a/src/pages/index.tsx b/src/pages/index.tsx new file mode 100644 index 0000000..b9af674 --- /dev/null +++ b/src/pages/index.tsx @@ -0,0 +1,54 @@ +import Heading from '@theme/Heading'; +import Layout from '@theme/Layout'; +import Link from '@docusaurus/Link'; +import styles from './index.module.css'; + +export default function Home(): JSX.Element { + return ( + +
+
+ + Permanent storage, simplified + +

+ Explore guides, tutorials, and references for building with Lighthouse on Filecoin and IPFS. +

+
+ + Start building + + + Generate an API key + +
+
+
+
+
+
+ How-to guides +

Follow step-by-step instructions for uploading, encrypting, and managing data on Lighthouse.

+ Browse guides → +
+
+ Tutorials +

Build applications end-to-end with walkthroughs covering NFTs, token gating, and more.

+ Explore tutorials → +
+
+ Concepts +

Learn the fundamentals behind Lighthouse, Filecoin storage, and IPFS CID formats.

+ Read concepts → +
+
+
+ + ); +} diff --git a/.gitbook/assets/Api de.png b/static/img/Api de.png similarity index 100% rename from .gitbook/assets/Api de.png rename to static/img/Api de.png diff --git a/.gitbook/assets/CID deal.png b/static/img/CID deal.png similarity index 100% rename from .gitbook/assets/CID deal.png rename to static/img/CID deal.png diff --git a/.gitbook/assets/DogDiagram.png b/static/img/DogDiagram.png similarity index 100% rename from .gitbook/assets/DogDiagram.png rename to static/img/DogDiagram.png diff --git a/.gitbook/assets/Frontend.png b/static/img/Frontend.png similarity index 100% rename from .gitbook/assets/Frontend.png rename to static/img/Frontend.png diff --git a/.gitbook/assets/Group 1707478178.png b/static/img/Group 1707478178.png similarity index 100% rename from .gitbook/assets/Group 1707478178.png rename to static/img/Group 1707478178.png diff --git a/.gitbook/assets/Group 1707478179.png b/static/img/Group 1707478179.png similarity index 100% rename from .gitbook/assets/Group 1707478179.png rename to static/img/Group 1707478179.png diff --git a/.gitbook/assets/IPNS_1.webp b/static/img/IPNS_1.webp similarity index 100% rename from .gitbook/assets/IPNS_1.webp rename to static/img/IPNS_1.webp diff --git a/.gitbook/assets/IPNS_2.png b/static/img/IPNS_2.png similarity index 100% rename from .gitbook/assets/IPNS_2.png rename to static/img/IPNS_2.png diff --git a/.gitbook/assets/IPNS_3.png b/static/img/IPNS_3.png similarity index 100% rename from .gitbook/assets/IPNS_3.png rename to static/img/IPNS_3.png diff --git a/.gitbook/assets/IPNS_4.png b/static/img/IPNS_4.png similarity index 100% rename from .gitbook/assets/IPNS_4.png rename to static/img/IPNS_4.png diff --git a/.gitbook/assets/IPNS_5.png b/static/img/IPNS_5.png similarity index 100% rename from .gitbook/assets/IPNS_5.png rename to static/img/IPNS_5.png diff --git a/.gitbook/assets/IPNS_6.png b/static/img/IPNS_6.png similarity index 100% rename from .gitbook/assets/IPNS_6.png rename to static/img/IPNS_6.png diff --git a/.gitbook/assets/IPNS_7.png b/static/img/IPNS_7.png similarity index 100% rename from .gitbook/assets/IPNS_7.png rename to static/img/IPNS_7.png diff --git a/.gitbook/assets/IPNS_8.png b/static/img/IPNS_8.png similarity index 100% rename from .gitbook/assets/IPNS_8.png rename to static/img/IPNS_8.png diff --git a/.gitbook/assets/Python_1.png b/static/img/Python_1.png similarity index 100% rename from .gitbook/assets/Python_1.png rename to static/img/Python_1.png diff --git a/.gitbook/assets/Python_2.png b/static/img/Python_2.png similarity index 100% rename from .gitbook/assets/Python_2.png rename to static/img/Python_2.png diff --git a/.gitbook/assets/Python_3.png b/static/img/Python_3.png similarity index 100% rename from .gitbook/assets/Python_3.png rename to static/img/Python_3.png diff --git a/.gitbook/assets/Python_4.png b/static/img/Python_4.png similarity index 100% rename from .gitbook/assets/Python_4.png rename to static/img/Python_4.png diff --git a/.gitbook/assets/Python_5.png b/static/img/Python_5.png similarity index 100% rename from .gitbook/assets/Python_5.png rename to static/img/Python_5.png diff --git a/.gitbook/assets/Python_6 (1).png b/static/img/Python_6 (1).png similarity index 100% rename from .gitbook/assets/Python_6 (1).png rename to static/img/Python_6 (1).png diff --git a/.gitbook/assets/Python_6.png b/static/img/Python_6.png similarity index 100% rename from .gitbook/assets/Python_6.png rename to static/img/Python_6.png diff --git a/.gitbook/assets/Screenshot 2022-09-13 at 6.16.15 PM.png b/static/img/Screenshot 2022-09-13 at 6.16.15 PM.png similarity index 100% rename from .gitbook/assets/Screenshot 2022-09-13 at 6.16.15 PM.png rename to static/img/Screenshot 2022-09-13 at 6.16.15 PM.png diff --git a/.gitbook/assets/Screenshot 2023-01-18 at 4.12.21 PM.png b/static/img/Screenshot 2023-01-18 at 4.12.21 PM.png similarity index 100% rename from .gitbook/assets/Screenshot 2023-01-18 at 4.12.21 PM.png rename to static/img/Screenshot 2023-01-18 at 4.12.21 PM.png diff --git a/.gitbook/assets/Screenshot 2023-01-21 at 3.05.41 AM.png b/static/img/Screenshot 2023-01-21 at 3.05.41 AM.png similarity index 100% rename from .gitbook/assets/Screenshot 2023-01-21 at 3.05.41 AM.png rename to static/img/Screenshot 2023-01-21 at 3.05.41 AM.png diff --git a/.gitbook/assets/Screenshot 2023-07-20 153056 (1).png b/static/img/Screenshot 2023-07-20 153056 (1).png similarity index 100% rename from .gitbook/assets/Screenshot 2023-07-20 153056 (1).png rename to static/img/Screenshot 2023-07-20 153056 (1).png diff --git a/.gitbook/assets/Screenshot 2023-07-20 153056.png b/static/img/Screenshot 2023-07-20 153056.png similarity index 100% rename from .gitbook/assets/Screenshot 2023-07-20 153056.png rename to static/img/Screenshot 2023-07-20 153056.png diff --git a/.gitbook/assets/Screenshot 2023-07-20 153345.png b/static/img/Screenshot 2023-07-20 153345.png similarity index 100% rename from .gitbook/assets/Screenshot 2023-07-20 153345.png rename to static/img/Screenshot 2023-07-20 153345.png diff --git a/.gitbook/assets/Screenshot 2023-10-20 195553.png b/static/img/Screenshot 2023-10-20 195553.png similarity index 100% rename from .gitbook/assets/Screenshot 2023-10-20 195553.png rename to static/img/Screenshot 2023-10-20 195553.png diff --git "a/.gitbook/assets/Screenshot 2023-10-21 at 10.39.34\342\200\257AM.png" "b/static/img/Screenshot 2023-10-21 at 10.39.34\342\200\257AM.png" similarity index 100% rename from ".gitbook/assets/Screenshot 2023-10-21 at 10.39.34\342\200\257AM.png" rename to "static/img/Screenshot 2023-10-21 at 10.39.34\342\200\257AM.png" diff --git "a/.gitbook/assets/Screenshot 2023-10-21 at 9.41.08\342\200\257AM.png" "b/static/img/Screenshot 2023-10-21 at 9.41.08\342\200\257AM.png" similarity index 100% rename from ".gitbook/assets/Screenshot 2023-10-21 at 9.41.08\342\200\257AM.png" rename to "static/img/Screenshot 2023-10-21 at 9.41.08\342\200\257AM.png" diff --git a/.gitbook/assets/Screenshot_2025-09-26_at_8.56.13_AM.webp b/static/img/Screenshot_2025-09-26_at_8.56.13_AM.webp similarity index 100% rename from .gitbook/assets/Screenshot_2025-09-26_at_8.56.13_AM.webp rename to static/img/Screenshot_2025-09-26_at_8.56.13_AM.webp diff --git a/.gitbook/assets/Screenshot_2025-09-26_at_8.58.04_AM.webp b/static/img/Screenshot_2025-09-26_at_8.58.04_AM.webp similarity index 100% rename from .gitbook/assets/Screenshot_2025-09-26_at_8.58.04_AM.webp rename to static/img/Screenshot_2025-09-26_at_8.58.04_AM.webp diff --git a/.gitbook/assets/Screenshot_2025-09-26_at_9.01.40_AM.webp b/static/img/Screenshot_2025-09-26_at_9.01.40_AM.webp similarity index 100% rename from .gitbook/assets/Screenshot_2025-09-26_at_9.01.40_AM.webp rename to static/img/Screenshot_2025-09-26_at_9.01.40_AM.webp diff --git a/.gitbook/assets/Screenshot_2025-09-26_at_9.04.07_AM.webp b/static/img/Screenshot_2025-09-26_at_9.04.07_AM.webp similarity index 100% rename from .gitbook/assets/Screenshot_2025-09-26_at_9.04.07_AM.webp rename to static/img/Screenshot_2025-09-26_at_9.04.07_AM.webp diff --git a/.gitbook/assets/Screenshot_2025-09-26_at_9.17.17_AM.webp b/static/img/Screenshot_2025-09-26_at_9.17.17_AM.webp similarity index 100% rename from .gitbook/assets/Screenshot_2025-09-26_at_9.17.17_AM.webp rename to static/img/Screenshot_2025-09-26_at_9.17.17_AM.webp diff --git a/.gitbook/assets/api key.png b/static/img/api key.png similarity index 100% rename from .gitbook/assets/api key.png rename to static/img/api key.png diff --git a/.gitbook/assets/cli-home.png b/static/img/cli-home.png similarity index 100% rename from .gitbook/assets/cli-home.png rename to static/img/cli-home.png diff --git a/.gitbook/assets/cli-screenshot.png b/static/img/cli-screenshot.png similarity index 100% rename from .gitbook/assets/cli-screenshot.png rename to static/img/cli-screenshot.png diff --git a/static/img/favicon.svg b/static/img/favicon.svg new file mode 100644 index 0000000..05c23a6 --- /dev/null +++ b/static/img/favicon.svg @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/.gitbook/assets/fevm-1.svg b/static/img/fevm-1.svg similarity index 100% rename from .gitbook/assets/fevm-1.svg rename to static/img/fevm-1.svg diff --git a/.gitbook/assets/file.excalidraw.svg b/static/img/file.excalidraw.svg similarity index 100% rename from .gitbook/assets/file.excalidraw.svg rename to static/img/file.excalidraw.svg diff --git a/.gitbook/assets/go-banner.png b/static/img/go-banner.png similarity index 100% rename from .gitbook/assets/go-banner.png rename to static/img/go-banner.png diff --git a/.gitbook/assets/go-cli.png b/static/img/go-cli.png similarity index 100% rename from .gitbook/assets/go-cli.png rename to static/img/go-cli.png diff --git a/.gitbook/assets/image (1) (1).png b/static/img/image (1) (1).png similarity index 100% rename from .gitbook/assets/image (1) (1).png rename to static/img/image (1) (1).png diff --git a/.gitbook/assets/image (1).png b/static/img/image (1).png similarity index 100% rename from .gitbook/assets/image (1).png rename to static/img/image (1).png diff --git a/.gitbook/assets/image (2) (1).png b/static/img/image (2) (1).png similarity index 100% rename from .gitbook/assets/image (2) (1).png rename to static/img/image (2) (1).png diff --git a/.gitbook/assets/image (2).png b/static/img/image (2).png similarity index 100% rename from .gitbook/assets/image (2).png rename to static/img/image (2).png diff --git a/.gitbook/assets/image (3).png b/static/img/image (3).png similarity index 100% rename from .gitbook/assets/image (3).png rename to static/img/image (3).png diff --git a/.gitbook/assets/image (4).png b/static/img/image (4).png similarity index 100% rename from .gitbook/assets/image (4).png rename to static/img/image (4).png diff --git a/.gitbook/assets/image.png b/static/img/image.png similarity index 100% rename from .gitbook/assets/image.png rename to static/img/image.png diff --git a/.gitbook/assets/logo white-02-min.jpg b/static/img/logo white-02-min.jpg similarity index 100% rename from .gitbook/assets/logo white-02-min.jpg rename to static/img/logo white-02-min.jpg diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..ecf6df0 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,6 @@ +{ + "extends": "@tsconfig/docusaurus/tsconfig.json", + "compilerOptions": { + "types": ["@docusaurus/module-type-aliases"] + } +} diff --git a/vercel.json b/vercel.json new file mode 100644 index 0000000..dc0c25b --- /dev/null +++ b/vercel.json @@ -0,0 +1,6 @@ +{ + "buildCommand": "npm run build", + "outputDirectory": "build", + "installCommand": "npm install", + "framework": "docusaurus" +}