An example of Pype in use


Last updated October 31st, 2017

General workflow

When you have written a new document, it needs to be committed and pushed to the doc repository before the changes will show up in your Pype-powered website.

The updating of your Pype site is handled by your Github webhook automatically.

However, on your local machine, you can make use of the following workflow:

  • Use your site's content directory for creating/editing pages/posts.
  • Commit your changes to the local content repository, but don't push!
  • Run yii mdpages/pages/local-update to update your local site's page database

Of course, to update your real site, push to the remote repository, and the webhook will update it as usual.

Command-line interface

While you won't be running these commands on a daily basis, here is a brief overview of the various console commands that Pype provides.

To see a list of commands available you can run this command:

./yii help mdpages/pages

Console Commands

init

To clone the docs repository and build the pages database:

./yii mdpages/pages/init

update

This command checks if there are changes in the remote and if there are it will pull the changes and update the page database:

./yii mdpages/pages/update

The update command is also what is called automatically by the Github webhook.

local-update

This command checks if there are changes that have not yet been pushed to the remote repository and updates the page database:

./yii mdpages/pages/local-update

Use this command while writing a page/post, until you're ready to push.

rebuild

The rebuild command will trigger a full rebuild of the page database, without modifying the modified page field:

./yii mdpages/pages/rebuild

The rebuild command does not check for remote changes nor does it pull anything.

clear-all

If you want to delete both the content repository and the page database, run this command:

./yii mdpages/pages/clear-all

Utility command to symlink the images directory from the content repository in the web directory:

./yii mdpages/pages/symlink

The deploy script calls that command at it's completion, because a new deployment means that the old symlink will break.


Edit on Github

Contributors to this page