mdbook-newday

Crates.iomdbook-newday
lib.rsmdbook-newday
version0.3.0
created_at2021-11-20 13:24:30.240069+00
updated_at2025-09-09 01:25:20.748636+00
descriptionA commandline tool to add a new day to the top of the summary of an mdbook
homepage
repository
max_upload_size
id484900
size24,885
Douglas H. Bradshaw (dhbradshaw)

documentation

README

mdbook-newday

Motivation

With a lot of projects I like to keep a log or journal. Mdbook is a nice way to do that, but I find that actually entering in the day and date and creating a new file can be error prone and tedious.

What mdbook-newday does

mdbook-newday is a very special purpose command that will take a SUMMARY.mdfile and add a line to it for the current day.

The format of that line is

- [%A, %b %d, %Y](./%Y/%Y-%m/%Y-%m-%d.md), ie

- [Thursday, Jan 01, 1970](./1970/1970-01/1970-01-01.md),

If you then run mdbook serve, it will create a file at ./1970/1970-01/1970-01-01.md .

The file will be automatically given a title in the form # Thursday, Jan 01, 1970 .

Usage

Basic usage (add today's entry)

mdbook-newday path/to/SUMMARY.md

Plan ahead usage (add entries for the next n days)

mdbook-newday --plan-ahead 5 path/to/SUMMARY.md

This will add entries for the next 5 days (tomorrow, day after tomorrow, etc.) in reverse chronological order (newest first), which is typical for journals and logs.

Options

  • --plan-ahead <n>: Add entries for the next n days instead of just today. The argument must be a positive number.

Examples

Add today's entry:

mdbook-newday SUMMARY.md

Add entries for the next 7 days:

mdbook-newday --plan-ahead 7 SUMMARY.md

The command is idempotent - running it multiple times will not create duplicate entries.

Commit count: 0

cargo fmt