Welcome to Permaweb Journal, an onchain publication covering the Arweave and AO ecosystems. We cover ecosystem developments, projects, and insights, ensuring that information is permanently stored and accessible on the permaweb.
This repository powers the Permaweb Journal website, built using Quartz, a lightweight static site generator for publishing Markdown-based content.
/content– Markdown files for site pages, articles and references./quartz- static site generator (full docs here)/quartz/static- Assets like images and logos./scripts– Automation scripts for publishing on the permaweb.
To set up and run Permaweb Journal locally, follow these steps:
Quartz requires at least Node v20 and npm v9.3.1 to function correctly. Ensure you have this installed on your machine before continuing.
- Clone the repository:
git clone https://github.com/afisher3578/permaweb-journal.git cd permaweb-journal - Install dependencies:
npm install
- Start the local server:
The site will be available at
npx quartz build --serve
http://localhost:8080.
We welcome contributions to improve Permaweb Journal. You can submit projects, articles, feature requests, or bug reports.
To add a project to the Permaweb Journal ecosystem list:
- Open an issue using the Project Request template.
- Provide details like the project name, description, category, and relevant links.
- Fork the repository and create a new Markdown file under
/content/articlesor/content/reference - Follow the existing article structure.
- Open a pull request (PR) with a brief summary of your page.
- Open an issue with the Feature Request template.
- Clearly describe the feature and its benefits.
- Open an issue with the Bug Report template.
- Provide steps to reproduce the issue and expected behavior.
For questions about Permaweb Journal or about guest posting DM Alex on X .