kraftify.lol / docs / demo

docs

The kraftify.lol documentation. This is a demo page showing what real docs will look like once the team writes better words. Short sentences, no em dashes, mis-sized typography in the right places.

overview

kraftify.lol is a placeholder for a real company. The whole site is placeholder until the team writes better copy. This page is the template those docs will ship in.

The working style is locked in already. Short sentences. No em dashes. Commands are real, the output is fake, and every example is a demo.

demo · how it feels

# kraft is the thing that pushes pages to the edge
kraft preview
  > site      kraftify.lol
  > branch    main
  > words     placeholder

install

Grab the binary from the releases page or build from source. Building from source takes about a minute and a half.

shell

# build from source
git clone https://git.kraftify.lol/placeholder/kraft
cd kraft
make install

Verify the install.

shell

kraft --version
  > v0.0.0-placeholder

cli

The kraft command is the primary interface. Every command reads kraft.toml first, then does the thing.

command	does what
`kraft init`	writes a placeholder config to ./kraft.toml
`kraft pull`	syncs pages from the repo to the site
`kraft push`	ships local pages to the edge
`kraft preview`	renders local pages so you can look at them
`kraft wipe`	deletes everything. for testing only. important

Non-interactive runs take --yes. Interactive runs take coffee.

config

kraft reads ./kraft.toml, then kraft.lol.toml, then the first file named kraft it finds. These are the options people actually touch.

kraft.toml

# kraft.toml, demo values
site = "https://kraftify.lol"

[deploy]
branch   = "main"
host     = "placeholder"
cache    = "immutable"

[out]
dir   = "public"
clean = true

max file size 1mb. anything bigger gets a page of its own.

faq

this is all placeholder, right?

correct. every word on kraftify.lol is placeholder until the team writes better copy.

can i use this docs template?

sure. copy the page, swap the words, ship it.

em dashes?

banned. use a slash or a middot.

where can i test the cli?

run kraft init in an empty folder. nothing bad happens. probably.

page docs · edit this section