azk documentation

azk documentation was built upon Gitbook.

Starting Gitbook server with azk

azk start -o && azk logs --follow

After a few minutes, azk docs will be up and running on docs-azk.dev.azk.io. :)

Starting Gitbook server without azk

npm i
npm i gitbook-cli // gitbook-cli has to be installed after gitbook
gitbook versions:link node_modules/gitbook 2.6.7
gitbook install content
gitbook serve --port 4000 content

azk docs will be up and running on http://localhost:4000

Deploying

Before deploying you must create a file called .env or copy and update .env.sample

AWS_ACCESS_KEY_ID=XXXXXXXXXXXXXX
AWS_SECRET_KEY=XXXXXXXXXXXXXXXXX
AWS_BUCKET_PROD=[bucket to prod deploy]
AWS_BUCKET_STAGE=[bucket to stage deploy]
GA_UA=UA-XXXXXXXX-X
GA_LEGACY_COOKIE_DOMAIN=azk.io
HOTJAR_ID=XXXXXXX

azk buckets

# stage
azk-docs-stage

# production
docs.azk.io

Build and deploy

azk shell -- gulp deploy-stage
azk shell -- gulp deploy-prod

[! danger !] to remove all files from a bucket use s3cmd

s3cmd del s3://azk-docs-stage/ --recursive --force
rm .awspublish-azk-docs-stage

Screenshot terminal configuration

Font: Inconsolata Font-size: 15pt Console columns: 87 Shell: zsh Zsh Theme: edvardm iTerm Color: Dracula Theme

To change the window title for iTerm, you can do

echo -ne "\033];azk agent start --no-daemon\007"

You may also disable (uncheck) the window number by going to iTerm -> Preferences -> Appearance -> Window & Tab title -> Show window number

For that to work, you'll also need to go to your .zshrc file and uncomment the line:

DISABLE_AUTO_TITLE="true"

And go to iTerm -> Preferences -> Appearance -> Window & Tab Titles and uncheck everything.

If you're using a Mac, use Cmd + Shift + 4, then press Space and Left-click to take the screenshot of the terminal. Use the azkdemo application found here.