Reference
Configuration options
Nue has a hierarchical configuration system where the site-wide settings are specified in the site.yaml
file on the root directory, the application-level settings are specified in <appdir>/app.yaml
, and page-level settings in the front matter section of a Markdown file. App settings extend/override the global settings and page settings extend/override the app settings.
All options
An alphabetical index of all the configuration options:
appdir
Name of the application directory a page belongs to. For example, the root level index.md
could set this to "home" and read the layout, data, scripts, styles, and components from that directory.
automount
Setting this to false
disables automatic mounting of reactive islands. This is enabled (true
) by default.
base
The base directory is where all the styles and components are loaded on the front end. This is similar to simple-blog.nuejs.org
.
draw_sections
Setting this to true
makes Nuemark wrap the Nuemark content inside a <section>
element even if there are no sections defined on the page. Setting this globally makea consistent HTML structure for your external CSS.
main
By default, Nue looks for a file named "main.js" and includes it automatically on your page requests. You can change this with this setting. For example, a value such as ['index.js']
would auto-include "index.js". See details of JS/TS modules
bundle
Specifies files that should be bundled so that the imported dependencies are *inlined into the file itself. For example: bundle: [index.js]
. See to bundle or not to bundle.
class
Sets the <body :class="class">
attribute in the default HTML layout for page-specific CSS rules.
dist
The output directory. The default is .dist/dev
for the development version and .dist/prod
for the minified production version.
content_collection
This is a directory name for a content collection. Setting this to "posts" makes all the Markdown pages and their metadata available as a looped array for your template files. Good for making blog/docs indexes.
collection_name
The name of the looped variable on the content collection. By default, this is the name of the directory i.e. the value of the content_collection
option.
exclude
An array of CSS path matches to exclude from the page.
globals
A site-wide setting in your site.yaml
file to define directories that are global to all your applications. The scripts, styles, and components under global directories are automatically included on all your pages. See files and directories.
include
An array of matches to be included from the directories specified by the libs property. For example: include: [highlight, motion]
. A partial match is enough.
libs
A site-wide setting in your site.yaml
for CSS library directories to be used by the include statement.
lightning_css
Setting this to false
disables the default processing with Lightning CSS
hotreload
Setting this to false
disables universal hot-reloading. This is enabled (true
) by default.
inline_css
Setting this to true
inlines all CSS directly into the page to make it load faster. See performance optimization.
preload_image
This setting tells the browser about critical resources that you want to load as soon as possible before they are discovered in HTML. For example: preload_image: my-hero.png
port
The port number of the development server. Default is 8080
router
Setting this to true
enables [client-side-navigation] to make the successive page loads feel instant.