StrangerQuarkdown
GitHub
Home
X
FAQ
Walkthrough
X
quickstart
what is squarkdown?
project requirements
project structure
squarkdown-flavoured markdown
configuring repositories
configuring files
making full use of squarkdown
Docs
X
glossary
squarkup.json
X
CLI
X
squark charm
X
squarks
X
site data
cleanup
Features
X
page generation
assets
SCSS
fonts
Schema
X
latest (v5.0.7)
v5.0.6
v5.0.5
v5.0.4
v5.0.1
Info
X
synopsis
rationale
decoded
credits
licence

Walkthrough

Welcome to the Squarkdown walkthrough. For a lightning-quick overview of how it works, check out quickstart.

For detailed guidance on Squarkdown’s usage and features, see the below pages. You can read them in any order you like – this is just a recommended reading order.

  • What is Squarkdown?
  • Project Requirements
  • Project Structure
  • Squarkdown-flavoured Markdown
  • Configuring Squarkup for a Repository
  • Configuring Squarkup for a File
  • Making Full Use of Squarkdown

See something that needs fixing? Drop an issue on GitHub!

Squarkdown by Sup#2.0