Migrate from 0.2 to 0.3
A project on the 0.2 builds with the 0.3 as it is: every new field is optional.
Update
npm install docpensieve@latest
Through npx alone, npx docpensieve fetches the 0.3 by itself. Going back is
npm install docpensieve@0.2.0.
What changes on its own
| What | In 0.3 |
|---|---|
Pages with authors, date or modified | Open with a byline naming the authors and dates |
Nothing to change, but something to know: those three fields already existed, read by the sitemap and the page data without ever being shown. They are now shown, so a page that carries them gains a block it did not have. A page that carries none of them looks exactly as before.
tags follows the same path: read until now only by the page data, it now
shows at the bottom of every page that carries it.
One constraint is gone, too. A sidebar or authors file named in the
configuration no longer has to exist in every version folder: a version
without it keeps the menu of its folders, or shows the names alone.
On a narrow screen, the header changes for every site: the version switcher and
the search field move behind a menu button. Nothing to configure — headerLinks
only adds links to that menu.
What to turn on
| Field | Gives |
|---|---|
authors: 'authors.json' | Biographies, avatars and links, described per version |
<Cards /> in an index page | A grid of cards built from the pages of the folder |
DocPensieve