@compiiile/compiiile 2.18.0 → 2.18.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/README.md +31 -32
- package/bin/loadConfig.js +1 -1
- package/dist/style.css +1 -1
- package/package.json +29 -29
package/README.md
CHANGED
|
@@ -100,7 +100,7 @@ terminal to get Compiiile running with a couple of markdown files as tests:
|
|
|
100
100
|
|
|
101
101
|
```bash
|
|
102
102
|
# creating a new folder and go into this folder
|
|
103
|
-
mkdir test-compiiile && cd test-compiiile
|
|
103
|
+
mkdir test-compiiile && cd test-compiiile
|
|
104
104
|
# installing compiiile as global dependency using npm
|
|
105
105
|
npm i -g @compiiile/compiiile
|
|
106
106
|
# a first test file
|
|
@@ -108,7 +108,7 @@ echo '# Test Compiiile\n\n> Here is a blockquote for you\n\n## Your markdown awa
|
|
|
108
108
|
# a second test file as slides
|
|
109
109
|
echo '---\nasSlides: true\n---\n\n# Slide 1\n\n---\n\n# And this is slide 2' > slides.md
|
|
110
110
|
# running Compiiile for these 2 files
|
|
111
|
-
compiiile --title="📚 Compiiile"
|
|
111
|
+
compiiile --title="📚 Compiiile"
|
|
112
112
|
```
|
|
113
113
|
|
|
114
114
|
Et voilà , you should be able to preview your files in your browser :tada:.
|
|
@@ -201,24 +201,24 @@ The home page of Compiiile (`/`) points to a `README.md` file located at the roo
|
|
|
201
201
|
|
|
202
202
|
Here is the list of parameters that you can set to customize Compiiile (none are required):
|
|
203
203
|
|
|
204
|
-
| Parameter | Type
|
|
205
|
-
|
|
206
|
-
| `title` | `string`
|
|
207
|
-
| `description` | `string`
|
|
208
|
-
| `logo` | `string`
|
|
209
|
-
| `logoUrl` | `string`
|
|
210
|
-
| `dest` | `string`
|
|
211
|
-
| `siteUrl` | `string`
|
|
212
|
-
| `astroConfig` | `Object`
|
|
213
|
-
| `data` | `Object`
|
|
214
|
-
| `theme` | `string`
|
|
215
|
-
| `useAutoTitles` | `Boolean`
|
|
216
|
-
| `noIndex` | `Boolean`
|
|
217
|
-
| `publicDir` | `string`
|
|
218
|
-
| `vite.server.fs.allow` | `string[]`
|
|
219
|
-
| `printReady` | `Boolean`
|
|
220
|
-
| `css` | `string`
|
|
221
|
-
| `integrations` | `AstroIntegration[]`
|
|
204
|
+
| Parameter | Type | Description |
|
|
205
|
+
| ---------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
206
|
+
| `title` | `string` | The title to display on the top-left of the User Interface |
|
|
207
|
+
| `description` | `string` | The description that is rendered by default for the SEO |
|
|
208
|
+
| `logo` | `string` | The relative path of the logo to display in the TopBar and as favicon |
|
|
209
|
+
| `logoUrl` | `string` | The url to go to when clicking on the logo, defaults to the home page if not set |
|
|
210
|
+
| `dest` | `string` | The folder in which to build files, defaults to `./.compiiile/dist` |
|
|
211
|
+
| `siteUrl` | `string` | The url of the website in production (without trailing slash), used for the SEO tag `og:image` |
|
|
212
|
+
| `astroConfig` | `Object` | Override [default Astro config](https://docs.astro.build/en/reference/configuration-reference/) |
|
|
213
|
+
| `data` | `Object` | An object with data to use in MDX files (check use case below) |
|
|
214
|
+
| `theme` | `string` | The website theme, value can be : `auto` (default value: adapts to system preferences) \| `light` \| `dark` |
|
|
215
|
+
| `useAutoTitles` | `Boolean` | If set to `true`, use the first file heading as title to be displayed in the navbar and for SEO. Defaults to `false` |
|
|
216
|
+
| `noIndex` | `Boolean` | If set to `true`, the `robots.txt` file will disallow all routes, preventing indexation. Defaults to `false` |
|
|
217
|
+
| `publicDir` | `string` | The folder name in which you can serve public files, defaults to `public` |
|
|
218
|
+
| `vite.server.fs.allow` | `string[]` | Add local paths to vite's server fs allow list |
|
|
219
|
+
| `printReady` | `Boolean` | Add a `/print` page to display a full ready-to-print content (uses `@compiiile/compiiile-print`) |
|
|
220
|
+
| `css` | `string` | A relative path to a custom CSS file to customize the style <br/>:warning: Requires `compiiile-pro` |
|
|
221
|
+
| `integrations` | `AstroIntegration[]` | An array of Astro Integrations for [custom Astro hooks implementations](https://docs.astro.build/en/reference/integrations-reference/#astroconfigsetup): injecting CSS, javascript, etc |
|
|
222
222
|
|
|
223
223
|
You can use these parameters in 2 ways:
|
|
224
224
|
|
|
@@ -348,24 +348,23 @@ In your custom components, you can access the current page's frontmatter by usin
|
|
|
348
348
|
|
|
349
349
|
```vue
|
|
350
350
|
<template>
|
|
351
|
-
|
|
351
|
+
<p>{{ frontmatter.description }}</p>
|
|
352
352
|
</template>
|
|
353
353
|
|
|
354
354
|
<script>
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
355
|
+
import { site } from "virtual:compiiile"
|
|
356
|
+
|
|
357
|
+
export default {
|
|
358
|
+
name: "CustomComponent",
|
|
359
|
+
computed: {
|
|
360
|
+
frontmatter() {
|
|
361
|
+
return site.pageFrontmatter
|
|
362
|
+
}
|
|
363
|
+
}
|
|
364
|
+
}
|
|
365
365
|
</script>
|
|
366
366
|
```
|
|
367
367
|
|
|
368
|
-
|
|
369
368
|
## Ignoring files and folders
|
|
370
369
|
|
|
371
370
|
To ignore a whole folder or some files matching a certain pattern, you can add a `.compiiileignore` at the root of the folder where you run Compiiile.
|
package/bin/loadConfig.js
CHANGED
|
@@ -25,7 +25,7 @@ export const loadConfig = async () => {
|
|
|
25
25
|
name: process.env.COMPIIILE_TEMP_CONFIG_NAME || "compiiile",
|
|
26
26
|
cwd: process.env.COMPIIILE_TEMP_DIR || source
|
|
27
27
|
})
|
|
28
|
-
configFromFile = {...compiiileConfig.config}
|
|
28
|
+
configFromFile = { ...compiiileConfig.config }
|
|
29
29
|
if (!process.env.COMPIIILE_CONFIG_FILE) {
|
|
30
30
|
process.env.COMPIIILE_CONFIG_FILE = compiiileConfig.configFile
|
|
31
31
|
}
|