docpensieve 0.3.0 → 0.4.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docpensieve",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0-beta.1",
|
|
4
4
|
"description": "DocPensieve command-line interface (init, build, check, dev, serve)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -24,10 +24,10 @@
|
|
|
24
24
|
"types"
|
|
25
25
|
],
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@docpensieve/components": "0.
|
|
28
|
-
"@docpensieve/core": "0.
|
|
29
|
-
"@docpensieve/shared": "0.
|
|
30
|
-
"@docpensieve/theme": "0.
|
|
27
|
+
"@docpensieve/components": "0.4.0-beta.1",
|
|
28
|
+
"@docpensieve/core": "0.4.0-beta.1",
|
|
29
|
+
"@docpensieve/shared": "0.4.0-beta.1",
|
|
30
|
+
"@docpensieve/theme": "0.4.0-beta.1",
|
|
31
31
|
"chalk": "^6.0.0",
|
|
32
32
|
"chokidar": "^5.0.0",
|
|
33
33
|
"commander": "^15.0.0"
|
|
@@ -99,9 +99,9 @@ The documentation `init` installed in `99-docpensieve` stays at the version it
|
|
|
99
99
|
came with. To refresh it, run `init` in a scratch folder and copy that folder
|
|
100
100
|
over.
|
|
101
101
|
|
|
102
|
-
Coming from the 0.
|
|
103
|
-
changes on its own and what to check first. To try
|
|
104
|
-
|
|
102
|
+
Coming from the 0.3, [Migrate from latest to beta](./migrate-to-beta/) says
|
|
103
|
+
what changes on its own and what to check first. To try this beta, install
|
|
104
|
+
`docpensieve@beta`, or run `npx docpensieve@beta` alone.
|
|
105
105
|
|
|
106
106
|
## Checking
|
|
107
107
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Migrate from latest to beta
|
|
3
|
+
description: Move a project from the latest version, the 0.3, to the 0.4 beta — what changes on its own, and what to check.
|
|
4
|
+
tags: [guide, migration]
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Migrate from latest to beta
|
|
8
|
+
|
|
9
|
+
A project on the latest version — the 0.3 — builds with the 0.4 beta as it is:
|
|
10
|
+
every new field is optional.
|
|
11
|
+
|
|
12
|
+
## Update
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm install docpensieve@beta
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
Through `npx` alone, `npx docpensieve@beta` runs the beta. Going back is
|
|
19
|
+
`npm install docpensieve@latest`.
|
|
20
|
+
|
|
21
|
+
## What changes on its own
|
|
22
|
+
|
|
23
|
+
Nothing yet: the 0.4 has just opened. Each change is listed here as it lands,
|
|
24
|
+
beside what it asks of a project already built on the 0.3.
|
package/starter/05-whats-new.md
CHANGED
|
@@ -1,61 +1,28 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: What's new in 0.
|
|
3
|
-
description: What the 0.
|
|
2
|
+
title: What's new in 0.4
|
|
3
|
+
description: What the 0.4 brings, and what it changes for a 0.3 project.
|
|
4
4
|
tags: [release]
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
# What's new in 0.
|
|
7
|
+
# What's new in 0.4
|
|
8
8
|
|
|
9
|
-
This version is **
|
|
10
|
-
|
|
9
|
+
This version is **in preparation**. Its betas go out under the npm tag `beta`,
|
|
10
|
+
while the version installed by default stays the 0.3, documented in the
|
|
11
|
+
`latest` pages of this site:
|
|
11
12
|
|
|
12
13
|
```bash
|
|
13
|
-
|
|
14
|
+
npx docpensieve@beta init my-site
|
|
14
15
|
```
|
|
15
16
|
|
|
16
|
-
##
|
|
17
|
+
## Already there
|
|
17
18
|
|
|
18
|
-
|
|
19
|
+
Nothing yet: the 0.4 has just opened, and its pages are still those of the 0.3.
|
|
20
|
+
Each feature is announced here as it lands, with a link to the guide and to the
|
|
21
|
+
reference — this page announces, it is never the only place something is
|
|
22
|
+
written.
|
|
19
23
|
|
|
20
|
-
|
|
21
|
-
wrote it, and when. The names show as written; a JSON file of the version,
|
|
22
|
-
named by `authors: 'authors.json'`, adds a biography, an avatar and a link —
|
|
23
|
-
and feeds the page data with them. See
|
|
24
|
-
[Who wrote the page](./guide/writing-pages/) in the guide, and the
|
|
25
|
-
[`authors` field](./reference/configuration/) in the reference.
|
|
24
|
+
## For a 0.3 project
|
|
26
25
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
A folder is a series: its `index` page introduces it, and the pages beside
|
|
30
|
-
that index are its instalments. The `Cards` component turns that structure
|
|
31
|
-
into a grid of clickable cards — title, description, image, number of pages,
|
|
32
|
-
update date — instead of an index list written by hand, which goes stale at
|
|
33
|
-
the first page renamed. See [Cards](./components/cards/).
|
|
34
|
-
|
|
35
|
-
### Tags at the bottom of a page
|
|
36
|
-
|
|
37
|
-
The `tags` of a page, read until now only by its structured data, show at the
|
|
38
|
-
bottom of the page, below the text they describe. See
|
|
39
|
-
[The frontmatter](./guide/writing-pages/) in the guide.
|
|
40
|
-
|
|
41
|
-
### Description files, optional per version
|
|
42
|
-
|
|
43
|
-
A `sidebar` or `authors` file named in the configuration no longer has to
|
|
44
|
-
exist in every version folder. A version without it keeps the menu of its
|
|
45
|
-
folders, or shows the names its pages give: describing the menu or the authors
|
|
46
|
-
of a new version no longer forces a copy into the older ones. A file present
|
|
47
|
-
but unreadable, or wrongly written, still stops the build.
|
|
48
|
-
|
|
49
|
-
### Header links, and a menu on narrow screens
|
|
50
|
-
|
|
51
|
-
`headerLinks` adds links to the header, beside the version switcher — each may
|
|
52
|
-
name the version it leads to, so that a section written in one version is
|
|
53
|
-
reachable from all of them. On a narrow screen, the switcher, the links and the
|
|
54
|
-
search field move behind a menu button, which opens without a script. See the
|
|
55
|
-
[`headerLinks` field](./reference/configuration/).
|
|
56
|
-
|
|
57
|
-
## For a 0.2 project
|
|
58
|
-
|
|
59
|
-
Nothing to change: a 0.2 configuration builds as it is.
|
|
60
|
-
[Migrate from 0.2 to 0.3](./guide/migrate-from-0-2/) lists what changes on
|
|
26
|
+
Nothing to change: a 0.3 configuration builds as it is.
|
|
27
|
+
[Migrate from latest to beta](./guide/migrate-to-beta/) lists what changes on
|
|
61
28
|
its own, what to check, and what is worth turning on.
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Migrate from 0.2 to 0.3
|
|
3
|
-
description: Move a project from the 0.2 to the 0.3 — what changes on its own, and what to turn on.
|
|
4
|
-
tags: [guide, migration]
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Migrate from 0.2 to 0.3
|
|
8
|
-
|
|
9
|
-
A project on the 0.2 builds with the 0.3 as it is: every new field is optional.
|
|
10
|
-
|
|
11
|
-
## Update
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
npm install docpensieve@latest
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
Through `npx` alone, `npx docpensieve` fetches the 0.3 by itself. Going back is
|
|
18
|
-
`npm install docpensieve@0.2.0`.
|
|
19
|
-
|
|
20
|
-
## What changes on its own
|
|
21
|
-
|
|
22
|
-
| What | In 0.3 |
|
|
23
|
-
| ------------------------------------------ | ----------------------------------------------- |
|
|
24
|
-
| Pages with `authors`, `date` or `modified` | Open with a byline naming the authors and dates |
|
|
25
|
-
|
|
26
|
-
Nothing to change, but something to know: those three fields already existed,
|
|
27
|
-
read by the sitemap and the page data without ever being shown. They are now
|
|
28
|
-
shown, so a page that carries them gains a block it did not have. A page that
|
|
29
|
-
carries none of them looks exactly as before.
|
|
30
|
-
|
|
31
|
-
`tags` follows the same path: read until now only by the page data, it now
|
|
32
|
-
shows at the bottom of every page that carries it.
|
|
33
|
-
|
|
34
|
-
One constraint is gone, too. A `sidebar` or `authors` file named in the
|
|
35
|
-
configuration no longer has to exist in every version folder: a version
|
|
36
|
-
without it keeps the menu of its folders, or shows the names alone.
|
|
37
|
-
|
|
38
|
-
On a narrow screen, the header changes for every site: the version switcher and
|
|
39
|
-
the search field move behind a menu button. Nothing to configure — `headerLinks`
|
|
40
|
-
only adds links to that menu.
|
|
41
|
-
|
|
42
|
-
## What to turn on
|
|
43
|
-
|
|
44
|
-
| Field | Gives |
|
|
45
|
-
| ---------------------------- | ----------------------------------------------------- |
|
|
46
|
-
| `authors: 'authors.json'` | Biographies, avatars and links, described per version |
|
|
47
|
-
| `<Cards />` in an index page | A grid of cards built from the pages of the folder |
|