bluejay iconBluejay 0.7.0

What's New in Bluejay 0.5.0?

Install

$ bun add https://github.com/apacheli/bluejay

Debug Improvements

Slight improvements have been made to the debug information to include the size of each file.

The debug information.

BLUEJAY_MODE Variable

We removed options.mode in favor of using environment variables. Use BLUEJAY_MODE instead.

What each mode does:

BLUEJAY_PATH Variable

Removed options.path in favor of BLUEJAY_PATH.

See Bun's documentation for setting environment variables.

Heading Slugs

We added support for heading slugs, e.g., # Hello World becomes #hello-world. Click on the headings on this page to see how it works.

Custom Index and 404 Pages

You can use options.index and options.notFound to modify Bluejay's serve behavior. This option does nothing if BLUEJAY_MODE === "build".

import { start } from "bluejay";

await start({
    index: "/",
    notFound: "/404",
});

Alerts

Bluejay 0.5.0 also comes with support for GitHub's alert syntax.

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.

This is a regular quote for reference.

You can use the following CSS to stylize the alert boxes:

/** For all alert boxes. */
.alerts-icon {
    height: 1rem;
    width: 1rem;
}

.alerts-text {
    font-weight: bold;
}

/** For each alert box. */
.alert-note {
    fill: blue;
}

.alert-note-text {
    color: blue;
}

Contributors

We love contributions! Check out our GitHub for more details.