◊(Local Yarn Code "other-files.scrbl at [56b50a38]")

File code-docs/other-files.scrbl artifact e6f91e53 part of check-in 56b50a38


#lang scribble/manual

@; SPDX-License-Identifier: BlueOak-1.0.0
@; This file is licensed under the Blue Oak Model License 1.0.0.

@(require "scribble-helpers.rkt")

@(require (for-label racket/base "../cache.rkt"))

@title[#:tag "other-files"]{Other files}

@section{Home page (@filepath{index.html.pp})}

Simple Pollen preprocessor file that generates the home page.

@section{Keyword Index (@filepath{keyword-index.rkt})}

Through its provided @tt{main} function, builds the keyword index page by pulling all the index
entries directly from the SQLite cache and sorting them by first letter.

@section{Blog (@filepath{blog.rkt})}

Through its provided @tt{main} function, creates a paginated listing of all @tech{articles} and
@tech{notes}.

@section{RSS Feed (@filepath{rss-feed.rkt})}

Through its provided @tt{main} function, creates the RSS feed in the file @filepath{feed.xml}. Both
articles and notes are included. Any article or note with either @racket["all"] or @racket["feed"]
in its @racket['conceal] meta is excluded.

@section{Cache initialization (@filepath{util/init.rkt})}

Creates and initializes the cache database with @racket[init-cache-db!] and
@racket[preheat-series!].

@section{New article template (@filepath{util/newpost.rkt})}

Prompts for a title, creates an article with a normalized version of the filename and today’s date,
and opens the article in an editor.