Skip to content

Latest commit

 

History

History
123 lines (84 loc) · 4.95 KB

README.md

File metadata and controls

123 lines (84 loc) · 4.95 KB

Gatsby

Decentralized Blog Template

A simple blog template that publishes to Arweave through Arlink integration.

🚀 Quick Start

  1. Clone and install

    git clone [your-repo-url]
cd arlink-blog
npm install

  2. Add your blog posts

    • Navigate to content/blog/
    • Create a new folder for each post (e.g., my-post-name/)
    • Add an index.md file in each folder with your content:
    ---
title: Your Post Title
date: "2024-03-21"
description: "Brief description of your post"
---

Your blog content goes here...

  3. Preview locally

    gatsby develop

    View at http://localhost:8000

  4. Publish to Arweave

    git add .
git commit -m "Add new blog post"
git push

    Your changes will automatically deploy to Arweave through Arlink.

📁 Content Structure

content/
└── blog/
    ├── post-1/
    │   └── index.md
    └── post-2/
        └── index.md

💡 Tips

  • Images should be placed in the same folder as your post's index.md
  • Use markdown formatting for your posts
  • Each post must have the frontmatter (title, date, description) as shown above

🚀 Quick start (Arlink)

Deploy this starter with one click on Arlink ⚡️:

🧐 What's inside?

A quick look at the top-level files and directories you'll see in a typical Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package.json
└── README.md

  1. /node_modules: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed.

  2. /src: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. src is a convention for "source code".

  3. .gitignore: This file tells git which files it should not track / not maintain a version history for.

  4. gatsby-browser.js: This file is where Gatsby expects to find any usage of the Gatsby browser APIs (if any). These allow customization/extension of default Gatsby settings affecting the browser.

  5. gatsby-config.js: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you'd like to include, etc. (Check out the config docs for more detail).

  6. LICENSE: This Gatsby starter is licensed under the 0BSD license. This means that you can see this file as a placeholder and replace it with your own license.

  7. package.json: A manifest file for Node.js projects, which includes things like metadata (the project's name, author, etc). This manifest is how npm knows which packages to install for your project.

  8. README.md: A text file containing useful reference information about your project.

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on the website. Here are some places to start:

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples, head to our documentation. In particular, check out the Guides, API Reference, and Advanced Tutorials sections in the sidebar.

💫 Deploy

Build and Deploy on ARlink

The fastest way to deploy and permanently host your React, Next.js, and other front-end applications on the PermaWeb. ARlink ensures true decentralization and permanence, making it the best alternative to traditional hosting platforms like Netlify. Plus, with upcoming features like staging deployments and ARNS custom subdomains, ARlink is shaping the future of decentralized web hosting. 🚀