@quartz-community/footer 0.1.0 → 0.1.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/CHANGELOG.md +6 -0
- package/README.md +15 -0
- package/dist/components/index.d.ts +8 -2
- package/dist/index.d.ts +1 -8
- package/package.json +5 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.1.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 76bb311: Add layout position documentation to README.
|
|
8
|
+
|
|
3
9
|
All notable changes to this project will be documented in this file.
|
|
4
10
|
|
|
5
11
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
|
package/README.md
CHANGED
|
@@ -39,6 +39,21 @@ ExternalPlugin.Footer({
|
|
|
39
39
|
| ------- | ------------------------ | ------- | ------------------------------------------------------------ |
|
|
40
40
|
| `links` | `Record<string, string>` | `{}` | A map of link labels to their URLs to display in the footer. |
|
|
41
41
|
|
|
42
|
+
## Layout
|
|
43
|
+
|
|
44
|
+
The footer component uses `position: footer` by default. You can override this in your `quartz.config.yaml`:
|
|
45
|
+
|
|
46
|
+
```yaml title="quartz.config.yaml"
|
|
47
|
+
plugins:
|
|
48
|
+
- source: "@quartz-community/footer"
|
|
49
|
+
enabled: true
|
|
50
|
+
layout:
|
|
51
|
+
position: footer
|
|
52
|
+
priority: 50
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
To disable the footer, set `enabled: false`.
|
|
56
|
+
|
|
42
57
|
## Documentation
|
|
43
58
|
|
|
44
59
|
See the [Quartz documentation](https://quartz.jzhao.xyz/plugins/Footer) for more information.
|
|
@@ -1,2 +1,8 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import { QuartzComponent } from '@quartz-community/types';
|
|
2
|
+
|
|
3
|
+
interface FooterOptions {
|
|
4
|
+
links: Record<string, string>;
|
|
5
|
+
}
|
|
6
|
+
declare const _default: (opts?: FooterOptions) => QuartzComponent;
|
|
7
|
+
|
|
8
|
+
export { _default as Footer, type FooterOptions };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,2 @@
|
|
|
1
|
-
|
|
1
|
+
export { Footer, FooterOptions } from './components/index.js';
|
|
2
2
|
export { QuartzComponent, QuartzComponentProps, StringResource } from '@quartz-community/types';
|
|
3
|
-
|
|
4
|
-
interface FooterOptions {
|
|
5
|
-
links: Record<string, string>;
|
|
6
|
-
}
|
|
7
|
-
declare const _default: (opts?: FooterOptions) => QuartzComponent;
|
|
8
|
-
|
|
9
|
-
export { _default as Footer, type FooterOptions };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quartz-community/footer",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Footer component for Quartz - displays site footer with links and version",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -44,7 +44,8 @@
|
|
|
44
44
|
"test": "vitest run",
|
|
45
45
|
"typecheck": "tsc --noEmit",
|
|
46
46
|
"check": "npm run typecheck && npm run lint && npm run format && npm run test",
|
|
47
|
-
"prepublishOnly": "npm run build"
|
|
47
|
+
"prepublishOnly": "npm run build",
|
|
48
|
+
"release": "npm run build && changeset publish"
|
|
48
49
|
},
|
|
49
50
|
"peerDependencies": {
|
|
50
51
|
"preact": "^10.0.0"
|
|
@@ -71,7 +72,8 @@
|
|
|
71
72
|
"sass": "^1.97.3",
|
|
72
73
|
"tsup": "^8.5.0",
|
|
73
74
|
"typescript": "^5.9.3",
|
|
74
|
-
"vitest": "^2.1.9"
|
|
75
|
+
"vitest": "^2.1.9",
|
|
76
|
+
"@changesets/cli": "^2.29.2"
|
|
75
77
|
},
|
|
76
78
|
"engines": {
|
|
77
79
|
"node": ">=22",
|