CustomiseWorkshop

The CustomiseWorkshop component provides an interface for editing the YAML properties detailed in the main workshop's _config.yml file. This is accomplished by providing a form that allows users to change the properties of the YAML fields in constrained ways. Advanced users may edit the file directly using the mavon-editor.

Data

Name Type Default value Description
currentTemplate File null Config file of the main repository in local memory.
isEditingTemplate Boolean false Whether the template is being edited.
bannerImg null null Currently unsupported.

Computed

Name Type Description
template File Config file of the main repository in the store.
configIssues Array.<Error> List of compile issues with the current template.

Requires

  • module:mavon-editor

Methods

editConfig()
components/CustomiseWorkshop.vue, line 135

Begin direct template editing.

pushConfig() → {Promise.<BNoticeComponent>}
components/CustomiseWorkshop.vue, line 143

Upload the local config to GitHub.
Returns:
Promise.<BNoticeComponent>

refresh()
components/CustomiseWorkshop.vue, line 159

Reload the template from the store, discarding unsaved changes.