Skip to content

Cardigan-Bay 0.8.0

Latest
Compare
Choose a tag to compare
@interstar interstar released this 25 Apr 15:58
· 15 commits to master since this release

Release 0.8.0 Notes

A lot of big changes, and some fixes.

Breaking Changes

There's been a change to the way we pass parameters to Cardigan Bay when starting up.

  • Command line arguments still work ... BUT
  • You are now encouraged to keep most of your configurations in a file called <page-directory>/system/config.edn

When Cardigan Bay starts it will start by reading the command line arguments. But then read the config.edn file.

The parameters defined in config.edn will take precedence over those defined on the command line.

Astute observers will note that the one parameter which can NOT be given in the config.edn file is the :directory ... as Cardigan Bay needs to know the directory before it can find the config.edn file

I've dithered about this for a while, but of all the options I considered, this seems the least confusing in practice. Basically either run Cardigan Bay with the default bedrock directory under the place where the code sits. Or, pass the -d flag on the command line as you have currently been doing, to point it at a different page directory. All the other parameters can now be kept within that page directory, in system/config.edn

Non-breaking Changes

Card level editing. This is the BIG ONE anyone who has used CB will have been waiting for. You can now edit an individual card. It's not particularly pretty yet (though hopefully it will get prettier soon), but now, when you open up the card bar at the bottom of a card, there's another edit-box with just the source of that particular card. So you can now do more focused editing.

Note, that while this is very useful, particularly on longer pages, it will never replace the one-big-text-box philosophy of Cardigan Bay. There will always be a canonical single text file view of a page.

Workspace Saving. This is also a big deal. As the server now has the ability to accept individual card updates, it means that the Workspace finally gets a [Save] button. So as you are working on code interactively in the workspace, you can hit the save button to store it. No need to copy and paste it into the page level editor.

Network Cards. These are still an experimental feature. But it's always been the intention for Cardigan Bay to support a type of card which is a hand-drawn network diagram of boxes and arrows. Each node is, itself, a link to a page. So you can make graphical overviews of topics that are then covered on their own pages. There's currently no graphical editor for this card type. But this version of CB does at least now have a reasonable looking rendering. (The graphical editor is being worked on, but not yet enabled)

Media Directory Cards. CB already has the <page-directory>/media/ as a place to store your media files. There is now a :system command for listing the media directory. And an extra card type for linking to a media file.