World Wide Scroll Getting Started Guide

So you've joined The Scroll Alliance and want to register root names on The Scroll. This guide is for you!

Follow this guide to get your site ready for the World Wide Scroll.

How to Get Your Site Ready for the World Wide Scroll

The World Wide Scroll (WWS) is designed to be a more intelligent, offline, and human-first alternative to the World Wide Web. As you prepare your site for the WWS, keep the following guidelines in mind:

  1. Utilize the Scroll Language: Scroll is the primary language of the WWS, designed to be simple and expandable for both humans and AIs. While you can use plain HTML, Markdown, or any language that compiles to HTML, using Scroll will streamline many other requirements. Learn more about Scroll at scroll.pub.
  1. Open Source and Public Domain: The WWS is designed for a post-copyright world and all content on the WWS is open-source and public domain.
  1. Leverage Git for Site Management: Unlike the traditional web, the WWS uses Git for site transfers. Your site must be stored in a publicly accessible Git repository. Platforms like ScrollHub, GitHub and GitLab offer free hosting for open-source projects.
  1. Design for Offline Use: Your site should function fully offline. Avoid using external JavaScript, images, or assets that require an internet connection. Ensure all necessary files are included in your Git repo. For large files, such as videos, linking to external sites is acceptable, but avoid adding unnecessarily large files directly to your repo.
  1. No Ads or Trackers: While commercial sites and sponsorships are welcome on the WWS, any form of JavaScript trackers or advertising is prohibited. Ensure your site is free from ads and trackers to maintain the integrity and privacy of the WWS.
  1. Launch your folder: When you are ready to submit your folder, simply submit your root.scroll additions as a pull request, via email, or on ScrollHub.

If you need any help with these guidelines, share your issue on github.com/breck7/wws/issues or r/WorldWideScroll or Twitter.

By adhering to these guidelines, you’ll help create a more intelligent, offline-first, and human-centric internet. Welcome to the World Wide Scroll!

WWS command line client one-liner install

From npm:

sudo npm install -g @breck/wws

From source:

git clone https://github.com/breck7/wws && cd wws && npm install --omit=dev && sudo npm install --omit=dev -g . && wws

Fetch sites

wws fetch scroll breck pldb

Start local server

wws start

OR just open static files

wws open

Uninstalling

sudo npm uninstall -g wws

The WWS client currently requires Node.js. More clients coming soon.

Keeping WWS server running

sudo npm install -g pm2 pm2 start wws start

Built with Scroll v158.0.4