Quartos build websites.
This site is one. Scroll through these stanzas to see how it's done.
- Write each page's <main> element in HTML5 or Markdown.
- Create options files for pages if you want to. Options are optional.
- Choose one of the four stock styles, customize it, or bring your own CSS.
- Preview your site locally and upload it to a host. (This site is hosted by Neocities.)
Follow the steps below to build a bad-quarto in the privacy of your own hard disk.
Copy this quarto.
Download the original stock
quarto as a ZIP file or use it as a template:
github.com/samkennerly/quarto
Quarto scripts require Python 3.6+. Some features need extras:
- Tidy 5.6+ to run the
quarto/clean
script - Mistune 0.8 to build pages from Markdown files
Take a quick look.
A quarto project is a folder with these four subfolders:
-
proof
is a proof copy of a static website. quarto
contains code to build the proof.ready
contains pages ready to be built.-
style
contains one or more stylesheets.
Quartos do not install anything. To remove a quarto project, delete it.
Edit the content.
A plain text editor can read and write quarto pages, options, styles, and code.
- Remove the stock pages.
- Delete everything in the
ready
folder except these files: -
ready/index.html ready/index.json
- Delete the
test
folder and loose files in the top-level folder if you want to. - Any change you might regret can be undone with git reset.
- Write a new page.
- Create
ready/not_found.html
with this text: -
<h1>Error 404: Not To Be</h1> <p>Ay, there's the point.</p> <a href="https://quarto.neocities.org/"> <img alt="Quarto logo" src="media/quarto.svg" width="100%"> </a>
- This page has a heading, a paragraph, and an image inside a link.
- It's just an example. Any other valid HTML5 or Markdown will do.
- Edit the home options.
- Replace
ready/index.json
with this text: -
{ "author": "Will Shakespeare?", "base": "https://quarto.neocities.org/", "description": "But, src! What links in yonder website break?", "email": "", "homelink": "Bad Quarto", "qlink": "Built badly by a quarto.", "styles": ["style.css"], "title": "Foul Papers" }
- Options are optional. Omit an option or leave it blank if you don't want it.
- This example has a blank
email
field. The Bard did not have Mail. - Add some page options.
- Create
ready/not_found.json
with this text: -
{ "description": "No is the status of your GET request.", "title": "The Tragedy of Errors" }
- Options in
not_found.json
are only used for thenot_found.html
page. - Missing options will be replaced with values from
index.json
.
Rewrite the book.
Open a terminal, cd to your quarto project, and run these commands:
- delete
- Delete old pages and styles from the
proof
folder. - (For safety, this only deletes files with
HTML
andCSS
suffixes.) -
quarto/delete html && quarto/delete css
- You'll have to delete the empty folders and cat pictures yourself.
- clean
- Clean and overwrite HTML files in the
ready
folder. - (Skip this script if you only write Markdown or don't have Tidy installed.)
-
quarto/clean
- Keep your foul papers in another folder if you want to preserve them.
- build
- Build
proof
pages. - (This does not copy, delete, or move files, but it overwrites proof pages.)
-
quarto/build
- Store any media files in the
proof
folder. Quarto scripts will not touch them. - apply
- Apply the celestial style from the
style
folder. - (Choose another stock style or add your own stylesheets if you want to.)
-
quarto/apply style/celestial
-
This script finds CSS files recursively and cats them into
proof/style.css
.
Open proof/index.html
in any browser to behold your brave new quarto.