seemore 1.4.2 → 1.5.0
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/README.md +7 -9
- package/dist/index.d.ts +1 -7
- package/dist/index.js +0 -7
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -112,9 +112,9 @@ The preview is not just for reading — it is the fastest way to fix what you ar
|
|
|
112
112
|
Inline editing is for local previews only — `seemore build` output is static, so nothing is emitted there. It is on by default in dev; switch it off with the `!` prefix:
|
|
113
113
|
|
|
114
114
|
```ts
|
|
115
|
-
export default
|
|
115
|
+
export default {
|
|
116
116
|
features: ['!content.edit'],
|
|
117
|
-
}
|
|
117
|
+
};
|
|
118
118
|
```
|
|
119
119
|
|
|
120
120
|
## Publish it to the web
|
|
@@ -126,7 +126,7 @@ npx seemore build # static export to dist/ for any host
|
|
|
126
126
|
The result is a `dist/` folder of plain web files: drop it on [Netlify](https://netlify.com), [Surge](https://surge.sh), [Cloudflare Pages](https://pages.cloudflare.com) or [GitHub Pages](https://pages.github.com), or hand it to any web host. Every page is prerendered to its own `index.html`, next to a `404.html` that every static host honours. On top of that, the small conventions individual hosts look for — `_redirects` for Netlify and Cloudflare Pages, `200.html` for Surge, `.nojekyll` for GitHub Pages — are written for you.
|
|
127
127
|
|
|
128
128
|
> [!TIP]
|
|
129
|
-
> Project sites on GitHub Pages live under `username.github.io/my-repo/`, not the root, so set `base` once: `
|
|
129
|
+
> Project sites on GitHub Pages live under `username.github.io/my-repo/`, not the root, so set `base` once: `base: '/my-repo/'` (or `--base /my-repo/` on the CLI). Building under GitHub Actions without it set prints the exact line to add.
|
|
130
130
|
|
|
131
131
|
## Configuration
|
|
132
132
|
|
|
@@ -134,9 +134,7 @@ Optional — a folder with no config file builds correctly everywhere. To adjust
|
|
|
134
134
|
|
|
135
135
|
```ts
|
|
136
136
|
// seemore.config.ts
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
export default defineConfig({
|
|
137
|
+
export default {
|
|
140
138
|
title: 'My Docs',
|
|
141
139
|
description: 'Everything about the thing.',
|
|
142
140
|
favicon: './favicon.svg',
|
|
@@ -149,7 +147,7 @@ export default defineConfig({
|
|
|
149
147
|
editLink: { base: 'https://github.com/you/repo/edit/main/docs' },
|
|
150
148
|
search: 'static', // or { provider: 'orama-cloud', endpoint, apiKey } / { provider: 'algolia', appId, apiKey, indexName }
|
|
151
149
|
exclude: ['drafts/**'],
|
|
152
|
-
}
|
|
150
|
+
};
|
|
153
151
|
```
|
|
154
152
|
|
|
155
153
|
### Search
|
|
@@ -190,12 +188,12 @@ A flat list of switches for fine control, set as an array on the `features` key.
|
|
|
190
188
|
|
|
191
189
|
```ts
|
|
192
190
|
// seemore.config.ts
|
|
193
|
-
export default
|
|
191
|
+
export default {
|
|
194
192
|
features: [
|
|
195
193
|
'navigation.path', // off by default → this turns it on
|
|
196
194
|
'!navigation.instant.prefetch', // on by default → this turns it off
|
|
197
195
|
],
|
|
198
|
-
}
|
|
196
|
+
};
|
|
199
197
|
```
|
|
200
198
|
|
|
201
199
|
| Flag | Default | Effect |
|
package/dist/index.d.ts
CHANGED
|
@@ -128,12 +128,6 @@ interface ResolvedSeemoreConfig {
|
|
|
128
128
|
configFile?: string;
|
|
129
129
|
}
|
|
130
130
|
|
|
131
|
-
/**
|
|
132
|
-
* Identity function that exists purely for types: it makes `seemore.config.ts` autocomplete
|
|
133
|
-
* every option — including every feature flag, which is a plain string union.
|
|
134
|
-
*/
|
|
135
|
-
declare function defineConfig(config: SeemoreConfig): SeemoreConfig;
|
|
136
|
-
|
|
137
131
|
/**
|
|
138
132
|
* Frontmatter is validated, not restricted: unknown keys pass through so that a corpus
|
|
139
133
|
* written for another tool still builds. Only the keys seemore acts on are typed.
|
|
@@ -147,4 +141,4 @@ declare const frontmatterSchema: z.ZodObject<{
|
|
|
147
141
|
}, z.core.$loose>;
|
|
148
142
|
type FrontmatterData = z.output<typeof frontmatterSchema> & Record<string, unknown>;
|
|
149
143
|
|
|
150
|
-
export {
|
|
144
|
+
export type { Feature, FeatureFlag, FrontmatterData, NavItem, ResolvedSeemoreConfig, SearchConfig, SeemoreConfig, Theme };
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":[
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|