syte v0.0.1-beta.13

syte

Syte is an opinionated static site generator. It's intended for simple use cases, e.g., personal sites and blogs.

Syte takes static files of any kind, a config file, and your ejs and markdown files and compiles them into static HTML files.

Markdown files are first preprocessed using ejs. This enables a more powerful developer experience by allowing programmatic access to the dynamic application environment from within your markdown content.

Install

npm install --global syte

Quick start

$ syte new mysite
$ cd mysite

This will create a new project called mysite with the following directory structure:

mysite
├── layouts
│   └── app.ejs
├── pages
│   └── index.md
├── static
│   └── app.css
└── app.yaml

Note:

• The layouts directory, pages directory, and app.yaml file are mandatory. The static directory is where you can put any static files, like JavaScript, CSS, favicon.ico, CNAME, etc. The entire static folder will be copied as is into the root directory for the production build.
• app.yaml can contain any arbitrary context you want and will be available in the ejs files.
• The pages directory can contain any number of ejs (.ejs) or markdown (.md) files.
• Pages can be nested arbitrarily deep. Their URLs will be the path to the file relative to the pages directory.
• Pages are able to supply context and configuration via front matter (yaml with leading and trailing ---). This context will be merged against the global context defined in app.yaml.

Let's say we want to add some blog pages to our site with the following urls:

• /blog
• /blog/my-post

$ mkdir pages/blog
$ touch pages/blog/index.ejs
$ touch pages/blog/my-post.md

The resulting directory now looks like the following:

mysite
├── layouts
│   └── app.ejs
├── pages
│   ├── blog
│   │   ├── index.ejs
│   │   └── my-post.md
│   └── index.md
├── static
│   └── app.css
└── app.yaml

In the pages/blog/my-post.md file we want to write a blog post:

---
title: My post
---

# My Post

This is my post.

Notice that the file uses front matter to define a title property for the page. Properties defined in the front matter will be available to the templates during compilation.

In our pages/blog/index.ejs page, we want to render a list of links to all blog posts:

<ul>
<% for (const page of pages) { _%>
<% if (page.urlPath.startsWith("/blog/")) { _%>
  <li>
    <a href="<%= pathTo(page) %>"><%= page.title %></a>
  </li>
<% } _%>
<% } _%>
</ul>

To view our pages while we develop them, we'll start the development server:

$ syte serve

This will spin up your syte project by default on http://localhost:3500. In this case, the three pages available to us are:

• http://localhost:3500
• http://localhost:3500/blog
• http://localhost:3500/blog/my-post

Finally, when we're ready to deploy, we can compile the source into static files with the following command.

$ syte build

This will output a directory called build (the default, but can be changed with -o option) into the current working directory with the following structure:

build
├── app.css
├── blog
│   ├── my-post
│   │   └── index.html
│   └── index.html
└── index.html
└── rss.xml

When deploying to some environments, you may need to prefix the urls with a root path (this is the case with some github pages sites). If you used the pathTo helper for all your relative url references, then you can build the site with a specified url path prefix. For example, if you are deploying to github pages for a repo named your-gh-repo, you would build your syte project with the following command:

$ syte build --urlPathPrefix your-gh-repo

RSS Feed

If your app config contains a base_url entry, then a rss.xml RSS feed is generated by the syte build command. In order to populate feed items, your pages will need to have date and title frontmatter items.

title: "My great post"
date: "2021-09-02"

Podcast RSS Feed

Syte can also generate a podcast RSS feed with the required fields for the iTunes podcast directory. Here are the required fields in app config (with some examples):

title: My Awesome Podcast
base_url: https://example.com
podcast_category: Technology
podcast_language: en-us
podcast_subtitle: The greatest podcast of all time
podcast_author: Jane Smith
podcast_summary: The greatest podcast of all time, featuring Jane Smith
podcast_explicit: 'no'
podcast_email: foo@example.com
podcast_img_url: https://example.com/logo.jpg

And each page will need the following frontmatter (with examples):

title: "1: This is an episode title"
date: "2021-12-07"
episode_url: 'https://example/audio/001_this_is_an_episode.mp3'
episode_duration: '4960'
episode_length: '99215166'
episode_summary: This episode is about being awesome.
episode_explict: 'yes'

The only slightly confusing fields here are likely episode_duration and episode_length. Episode duration refers to the length of your episode's mp3 file in seconds and can be calculated with this command ffprobe -show_entries stream=duration -of compact=p=0:nk=1 -v fatal MY_AWESOME_EPISODE.mp3. Episode length refers to the number of bytes of your episode's mp3 file and can be calculated with wc -c < MY_AWESOME_EPISODE.mp3.

The "show notes" for each episode will be generated from the page contents (after the frontmatter).

Farcaster auto-cast new posts

Syte can also "cast" your pages to Farcaster - a "sufficiently decentralized" social networking protocol. You'll need a Farcaster username and its corresponding private key.

You casts will consist of the page title and the page url, and should only send casts for new posts (or if the title/url changes), so this will run as part of your Syte's deploy process (like the RSS feed generation).

To auto-cast, your app config will need:

base_url: https://example.com
farcaster_username: whatrocks

You post frontmatter must include:

title: "My awesome page"
date: "2022-03-28"

Finally, you'll need to add an environment variable called FARCASTER_PRIVATE_KEY with your Farcaster username's private key.