« Home

Setup [guide-0001]

Steps to setup the project:

  1. Run raco pkg install --auto tr in the project
  2. Creates a directory mkdir your-site and goes into it
  3. Run raco tr init then update site.json

raco tr init do the following

  1. Create .gitignore with
    _tmp/
    _build/
    assets/
  2. Create site.json with
    {
      "domain": "your domain",
      "title": "your site title",
      "description": "your site description"
    }
  3. git clone https://git.sr.ht/\~dannypsnl/tr-assets assets
  4. Create directory content and content/post
  5. git init

Now you can add some *.scrbl in content/ directory as you wanted. Each *.scrbl is called a card.

Directory content/post is treated specially in that RSS only use cards in this directory as items.

A card addr.scrbl (no matter its full path) has an address addr, and the address must be unique in the whole TR project.

The content of card mostly are just HTML in at-exp form, scribble HTML describes more about what can be used.

Further guide will teach you what's in the toolbox.