NueJS configuration file

NueJS site configuration file

Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/nuejs-configuration-file/latest.json
Source https://www.schemastore.org/nuejs-site.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

$schema string
dist string

The output directory for the generated build files.

globals string[]

An array of global directories, automatically included on all pages.

hotreload boolean

Whether to enable hot reloading.

libs string[]

An array of directories treated as libraries.

lightning_css boolean

Whether to use Lightning CSS for processing of CSS.

native_css_nesting boolean

Whether to use native CSS nesting.

port integer

The port number for the development server. Defaults to 8080.

syntax_highlight boolean

Whether to enable syntax highlighting for code blocks within your Markdown content.

view_transitions boolean

Whether to enable view transitions for instant and smooth page switches.

inline_css boolean

Whether to inline all CSS directly into the HTML page.

base string

The value of the HTML element.

charset string

The value of the charset meta tag.

direction string

The value of the <html direction="{ direction }"> attribute, which defines the text direction of the document. The default is "ltr" (left to right)..

favicon string

The relative path to your favicon.

generator string

The generator meta tag that identifies the software used to create the site. The default is "Nue (nuejs.org)" and is only rendered in production mode.

heading_ids boolean

When set to true, all header levels (h2 and h3) will be generated with an id and an anchor () element.

language string

The value of the <html lang="{ language }"> attribute. The default is "en".

origin string

Your full domain name, including the protocol.

prefetch string[]

An array of assets to prefetch before they are used. These can include images, scripts, or CSS files.

robots string

The value for the robots meta property. Use "noindex" to exclude the entire website from search engine indexing.

theme_color string

The value for the theme color meta property.

viewport string

The viewport value. The default is: "width=device-width, initial-scale=1".

include string[]

A list of assets to be included from a library directory for all pages in the area. For example, a value like include: [highlight, motion] would include all files matching the strings highlight or motion in their filenames.

sections boolean | string[]

An array of CSS class names for the page sections, or true to render sections but not add any class names.

appdir string

The name of the application directory to which the page belongs.

content_collection string

The name of the directory for a content collection.

collection_name string

The name of the content collection variable. By default, this is the same as the directory name.

exclude string[]

A list of assets to be excluded from a library directory.

og_image string

The URL of the Open Graph image to represent the page on social media platforms.

og string

A shorthand alias for og_image, allowing for easier reference in the page settings.

og_description string

A brief description of the page to be used in Open Graph meta tags. This description appears in social media previews, providing context about the content when shared.

unlisted boolean

A setting that prevents the page from being included in content collections.