Migrate from 0.1 to 0.2
A project on the 0.1 builds with the 0.2 as it is: every new field is optional. A few things change on their own, though, and deserve a look.
Update
npm install docpensieve@latest
Through npx alone, npx docpensieve fetches the 0.2 by itself. Going back
is npm install docpensieve@0.1.5.
What changes on its own
| What | In 0.2 |
|---|---|
| Search | A field in the header, and a page at /search/ in each version |
sitemap.xml | Written at the root of the site as soon as siteUrl is set |
robots.txt | Written with it, when the site is served at the root of its domain |
| The stylesheet | Minified |
| Images | Their width and height are written; all but the first of a page load lazily |
| Light / dark switch | A button in the header, remembered from page to page — a few lines of inline script |
theme.darkMode | Now read: 'dark' and 'light' keep one scheme, 'class' follows the system |
Every page now carries the few lines of the light / dark switch —
theme.toggle: false removes them — and the search page loads its own script.
What to check
- A page of yours at
/search/now stops the build: that address is the search page's. Rename your page, or setsearch: false. theme.darkModewas accepted and ignored in 0.1. A value other than'class'now takes effect — and an unknown one stops the build.- The light / dark switch is on by default.
theme.toggle: falseremoves it, and with it the only script content pages carry. - Your own
robots.txt, if you published one next to the site, is now written by the build when the site sits at the root of its domain. Setsitemap: falseto keep yours.
What to turn on
| Field | Gives |
|---|---|
sidebar: 'sidebar.json' | A menu written by hand, in each version's folder |
feed: true | An RSS feed of the pages that carry a date |
versions[].logo, favicon | A logo and a favicon of the version's own — a beta told apart |
search: false | No search at all, if the site does not need one |
Every field is in the configuration reference.
DocPensieve