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
contentdirectory for creating/editing pages/posts.
- Commit your changes to the local
contentrepository, but don't push!
yii mdpages/pages/local-updateto 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.
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
To clone the docs repository and build the pages database:
This command checks if there are changes in the remote and if there are it will pull the changes and update the page database:
The update command is also what is called automatically by the Github webhook.
This command checks if there are changes that have not yet been pushed to the remote repository and updates the page database:
Use this command while writing a page/post, until you're ready to push.
The rebuild command will trigger a full rebuild of the page database, without modifying the modified page field:
The rebuild command does not check for remote changes nor does it pull anything.
If you want to delete both the content repository and the page database, run this command:
Utility command to symlink the
images directory from the content repository in the
The deploy script calls that command at it's completion, because a new deployment means that the old symlink will break.