Page options
Scroll down for a complete list of all options.
The keys have values for those who JSON.
Page options are answers to questions like:
- Who wrote this page?
- Where are the stylesheet(s) and favicon?
- Which icons should be in the
#icons
section? - Do you want to reveal your email to the entire internet?
Each page's options (if any) must be in a valid JSON file.
Sites are merriest when they have a home.
Each quarto site must have a home page.
- The home page must be named
index.html
or ... index.md
,index.rst
,index.htm
, or any suffix but.json
.- The name
index.json
is reserved for home page options. - Home page options are defaults for any missing page options.
Leave an option blank if you don't want it. Quartos do not autocarrot blank options.
What's in a name?
If the path to a page is:
ready/examples/adrift.html
then that page's options file (if it has one) must be named:
ready/examples/adrift.json
Complete Options of Quarto
Paths in options files can be absolute URLs or relative paths from the home folder.
- author
- Page author name(s).
-
"Will Shakespeare, C. Marlowe"
- base
- The home page's canonical URL with the path component removed.
-
"https://bad-quarto.neocities.org/"
- copyright
- Copyright statement.
-
"© Will Shakespeare 2019."
- description
- Page description for search engines.
-
"In Scotland, no one can hear you scream."
- Email address to display.
-
"quarto.sites@gmail.com"
- favicon
- Path to the site's favicon.
-
"favicon.ico"
- homelink
- Text label for link to home page in <nav> menu.
-
"Quarto"
- icons
- [alt text, image path, link target] for each icon in
#icons
section. -
[ ["Neocities", "media/icons/neocities.png", "https://neocities.org/site/quarto/"], ["Twitter", "media/icons/twitter.svg", "https://twitter.com/quartosites/"] ]
- jscripts
- List of paths to JavaScript sources.
-
[ "https://ajax.googleapis.com/ajax/libs/jquery/3.4.1/jquery.min.js", "enterpriseQuality/resources/src/resource/intrusiveDialogBoxes_v2.js" ]
- klftext
- Extra HTML in
#klf
section. -
"<a href=\"https://neocities.org/\">Hosted by Neocities</a>."
- language
- ISO language code for the page's <html> element.
-
"language": "en"
- license
- License URL and text to display in
#klf
section. -
[ "https://creativecommons.org/licenses/by/4.0", "Licensed under a CC BY 4.0 license." ]
- meta
- Name and content for any extra <meta> tags.
-
{ "keywords": "airdrawndagger, cawdor, macduff, scottish play, spot" }
- nextlink
- Text label for link to next page.
-
"fwd ⇢"
- ogimage
- OpenGraph image for social media page previews.
-
"media/cauldron.png"
- prevlink
- Text label for link to previous page.
-
"⇠ rev"
- qlink
- Text label for link to the stock quarto.
-
"Built by a Quarto."
- styles
- Paths to stylesheets for this page.
-
[ "https://www.w3schools.com/html/styles.css", "style.css" ]
- title
- Page <title>.
-
"Macbeth II: Toil and Trouble"