docpensieve 0.2.0 → 0.3.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docpensieve",
-  "version": "0.2.0",
+  "version": "0.3.0-beta.1",
   "description": "DocPensieve command-line interface (init, build, check, dev, serve)",
   "type": "module",
   "license": "MIT",
@@ -24,10 +24,10 @@
     "types"
   ],
   "dependencies": {
-    "@docpensieve/components": "0.2.0",
-    "@docpensieve/core": "0.2.0",
-    "@docpensieve/shared": "0.2.0",
-    "@docpensieve/theme": "0.2.0",
+    "@docpensieve/components": "0.3.0-beta.1",
+    "@docpensieve/core": "0.3.0-beta.1",
+    "@docpensieve/shared": "0.3.0-beta.1",
+    "@docpensieve/theme": "0.3.0-beta.1",
     "chalk": "^6.0.0",
     "chokidar": "^5.0.0",
     "commander": "^15.0.0"

package/starter/01-guide/01-installation.md

@@ -99,9 +99,9 @@ The documentation `init` installed in `99-docpensieve` stays at the version it
 came with. To refresh it, run `init` in a scratch folder and copy that folder
 over.
 
-Coming from the 0.1, [Migrate from 0.1 to 0.2](./migrate-from-0-1/) says what
-changes on its own and what to check first. To try the version being prepared,
-install `docpensieve@beta`, or run `npx docpensieve@beta` alone.
+Coming from the 0.2, [Migrate from latest to beta](./migrate-to-beta/) says
+what changes on its own and what to check first. To try this beta, install
+`docpensieve@beta`, or run `npx docpensieve@beta` alone.
 
 ## Checking
 

package/starter/01-guide/07-migrate-to-beta.md

@@ -0,0 +1,24 @@
+---
+title: Migrate from latest to beta
+description: Move a project from the latest version, the 0.2, to the 0.3 beta — what changes on its own, and what to check.
+tags: [guide, migration]
+---
+
+# Migrate from latest to beta
+
+A project on the latest version — the 0.2 — builds with the 0.3 beta as it is:
+every new field is optional.
+
+## Update
+
+```bash
+npm install docpensieve@beta
+```
+
+Through `npx` alone, `npx docpensieve@beta` runs the beta. Going back is
+`npm install docpensieve@latest`.
+
+## What changes on its own
+
+Nothing yet: the 0.3 has just opened. Each change is listed here as it lands,
+beside what it asks of a project already built on the 0.2.

package/starter/01-guide/index.md

@@ -25,8 +25,8 @@ up.
    touching the HTML.
 6. **[Deployment](./deployment/)** — publish, and keep past versions
    online.
-7. **[Migrate from 0.1 to 0.2](./migrate-from-0-1/)** — move a 0.1 project to
-   the 0.2.
+7. **[Migrate from latest to beta](./migrate-to-beta/)** — move a 0.2 project
+   to the 0.3 beta.
 
 ## What to know first
 

package/starter/05-whats-new.md

@@ -1,80 +1,28 @@
 ---
-title: What's new in 0.2
-description: What the 0.2 brings, and what it changes for a 0.1 project.
+title: What's new in 0.3
+description: What the 0.3 brings, and what it changes for a 0.2 project.
 tags: [release]
 ---
 
-# What's new in 0.2
+# What's new in 0.3
 
-This version is **out**. It is what `npx docpensieve init my-site` installs,
-and what the `latest` pages of this site document:
+This version is **in preparation**. Its betas go out under the npm tag `beta`,
+while the version installed by default stays the 0.2, documented in the
+`latest` pages of this site:
 
 ```bash
-npm install docpensieve@latest
+npx docpensieve@beta init my-site
 ```
 
-What follows describes everything it brings, and
-[Migrate from 0.1 to 0.2](./guide/migrate-from-0-1/) says what to check in a
-0.1 project.
-
 ## Already there
 
-### A menu written by hand
-
-`sidebar: 'sidebar.json'` replaces the menu derived from the file tree with
-one you describe — pages in the order you want, categories, links outside the
-site. Each version reads its own file, since each has its own pages. A section
-can keep its automatic menu with a single entry, which is how the DocPensieve
-section stays whole without listing its pages.
-
-See [Writing the menu by hand](./guide/writing-pages/) in the guide, and the
-[`sidebar` field](./reference/configuration/) in the reference.
-
-### Search engines and feed readers
-
-With `siteUrl` set, the build writes `sitemap.xml` for search engines — and
-`robots.txt` when the site sits at the root of its domain. `feed: true` adds an
-RSS feed of the dated pages. See [Sitemap and feed](./reference/configuration/)
-in the reference.
-
-### Search
-
-A search field in the header, and a search page in each version. The index is
-built with the site, and the field is a plain form: only the search page loads
-a script of its own, and without it the page stays the list of every page. See
-[Search](./reference/configuration/) in the reference.
-
-### A colour scheme of your choosing, and a logo per version
-
-`theme.darkMode: 'dark'` keeps the site dark whatever the reader's system —
-`'light'` keeps it light; `'class'`, the default, still follows the system.
-Until now the field was accepted and did nothing. A version can also carry its
-own `logo` and `favicon`, to tell a beta apart at a glance. See the
-[configuration reference](./reference/configuration/).
-
-### A light / dark switch
-
-A button in the header switches between light and dark, and remembers the
-choice from page to page. It is on by default — a few lines of inline script
-in every page; `theme.toggle: false` removes it, and pages then load no script.
-
-### Lighter pages
-
-The stylesheet reaches the reader minified. Every image of a page gets its
-width and height, read from its file, so that the text no longer jumps when it
-arrives; all but the first load lazily, and are no longer preloaded — the
-first, often in view, keeps its normal loading. `CardImage` loads lazily too.
-
-### The API reference, and two example projects
-
-Every export of the five packages is in the [API reference](./reference/api/),
-generated from the JSDoc of the sources, so that it cannot drift from the code.
-The repository also holds two complete example projects, one per theme, built
-and checked on every run of its tests.
+Nothing yet: the 0.3 has just opened, and its pages are still those of the 0.2.
+Each feature is announced here as it lands, with a link to the guide and to the
+reference — this page announces, it is never the only place something is
+written.
 
-## For a 0.1 project
+## For a 0.2 project
 
-Nothing to change: a 0.1 configuration builds as it is. `sidebar: 'auto'`
-stays the default, and every new field is optional.
-[Migrate from 0.1 to 0.2](./guide/migrate-from-0-1/) goes through what changes
-on its own, what to check, and what is worth turning on.
+Nothing to change: a 0.2 configuration builds as it is.
+[Migrate from latest to beta](./guide/migrate-to-beta/) lists what changes on
+its own, what to check, and what is worth turning on.

package/starter/01-guide/07-migrate-from-0-1.md

@@ -1,57 +0,0 @@
----
-title: Migrate from 0.1 to 0.2
-description: Move a project from the 0.1 to the 0.2 — what changes on its own, what to check, what to turn on.
-tags: [guide, migration]
----
-
-# 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
-
-```bash
-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 set `search: false`.
-- **`theme.darkMode`** was 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: false` removes
-  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. Set
-  `sitemap: false` to 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](../reference/configuration/).