Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ All notable changes to this project are documented here. The format follows

## [Unreleased]

## [0.1.0] - 2026-09-24

The first release.

### Added

- Published on PyPI: `uv tool install akceo` or `pipx install akceo`.
Expand All @@ -19,9 +23,12 @@ All notable changes to this project are documented here. The format follows
diagram that would load or link to anything outside the deck, and on one longer than Mermaid's
50,000-character limit. A deck with a diagram grows by about 5.6 MB.
- The built page carries a Content-Security-Policy, so the browser refuses to load anything from
outside the file. A web font or `@import` in a custom theme no longer loads; use installed
fonts, or embed one as a `data:` URI.
outside the file. A web font or `@import` in a custom theme doesn't load; use installed fonts,
or embed one as a `data:` URI.
- `akceo check deck.md` runs every check a build runs, diagrams included, without writing a file.
- Per-slide style overrides: `style-h1`, `style-h2`, `style-lead`, `style-ul`, `style-ol` and
`style-sub` add inline CSS to that element, for one-off spacing fixes. They can't reference
files or URLs.
- `image-frame: no`, for the whole deck or one slide, drops the white panel behind images.
Mermaid diagrams without a frame are drawn in the deck theme's colors.
- Deck errors name the file, line and slide; theme and image errors name the file. Content a
Expand Down
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,15 @@ straight from disk, works offline, and survives being emailed or copied anywhere

## Install

Needs Python 3.12 or newer and [uv](https://docs.astral.sh/uv/).
Needs Python 3.12 or newer. Install the `akceo` command from PyPI with
[uv](https://docs.astral.sh/uv/) or [pipx](https://pipx.pypa.io/):

```sh
uv tool install akceo
pipx install akceo
```

To try changes that aren't released yet, install from the repository instead:

```sh
uv tool install git+https://github.com/LunarCommand/akceo
Expand Down
2 changes: 1 addition & 1 deletion examples/demo/deck.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ kicker: Getting started

Install once. After that it's a write, build, present loop.

1. Install: `uv tool install git+https://github.com/LunarCommand/akceo`
1. Install: `uv tool install akceo`
2. Write `deck.md`: a config block, then slides separated by `---`.
3. Build: `akceo build deck.md`
4. Present: open `deck.html` and use the arrow keys.
Expand Down
Loading