tilly 0.0.10

A cli for tracking Things I Learned (TIL)

Tilly

CLI for easily creating Today I Learned posts, inspired by Simon Willison.

Check this tilly-pub.github.io website that was genereated using Tilly :)

Installation

uv venv .venv
source .venv/bin/activate
uv pip install tilly

tilly commands

Usage: tilly [OPTIONS] COMMAND [ARGS]...

  TIL (Today I Learned) Command Line Interface.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  build           Build database tils.db.
  config          List config.
  copy-templates  Copy default templates to current repo for customization.
  gen-static      Generate static site from tils.db using datasette.
  hello           Say hello.
  list-plugins    List all available plugins.
  serve           Serve tils.db using datasette or the generated static...

Usage

Create a repo (or clone a repo from github):

git init

Add a TIL:

mkdir example # this will be the topic of your TIL.
echo "# My first TIL with tilly" > example/first-til.md

Commit your work:

git add .
git commit -m "adding first til"

Build the local tils.db:

tilly build

Serve you tils locally:

tilly serve

Generate a static site in the docs folder:

tilly config -l --output-folder docs
tilly gen-static

The static site can also be served locally:

tilly serve --static

You can now publish your static site to Github. Don't forget to configure the source folder docs in your repository's GitHub Pages settings.

Customize the default templates

Your can overwrite the default templates by first making a copy of the default templates:

tilly copy-templates

Change the templates to your liking, then generate your static site:

tilly gen-static --template-dir templates

Customized templates can also be served locally:

tilly serve --template-dir templates

Tilly plugins

Tilly's plugin system allows additional features to be implemented as Python code which can be wrapped up in a separate Python package. The underlying mechanism uses pluggy.

Available plugins

• tilly-sitemap: Generate robots.txt and sitemap.xml for tilly sites.

Creating your own Tilly plugin

You can easily create your own plugin by running the following command:

uvx cookiecutter gh:tilly-pub/tilly-plugin

This command runs cookiecutter and will use our tilly-plugin cookiecutter to setup a new project.

Development, building and publishing

uv venv .venv --python=3.11
source .venv/bin/activate
uv pip install .
uv pip install -r requirements-dev.txt
./build.sh
./publish.sh

Topics

By default, the topic of a TIL is determined by the directory structure. For example, a file at python/decorators.md would have the topic "python".

You can also specify additional topics directly in the markdown file using frontmatter. For example:

---
topics: ["decorators", "functional-programming"]
---

# How to use Python decorators

Content of your TIL here...

When using frontmatter topics:

• The directory-based topic will always be the primary topic for URL routing
• All topics (directory-based and frontmatter) will be searchable
• The file can still be organized in any directory structure

TODO

• document tilly-plugin creation
• add related article links using vector embeddings
• it should be possible to store the template folder in the config
• add rss feed

DONE

• support TILs with multiple categories (via frontmatter)
• render snippets in your pages, check here and here for an example.
• add search to the static site
• created cookiecutter tilly-plugin repo
• create plugin for generating sitemaps
• example github actions workflow for publishing tilly static pages
• add tests
• update README.md with latest tilly cli commands/options (python update_readme.py)