Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmengo committed Dec 12, 2024
1 parent 7228cbe commit 5b0886b
Show file tree
Hide file tree
Showing 10 changed files with 462 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shopify theme generate block [flags]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shopify theme generate section [flags]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
shopify theme generate template [flags]
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// This is an autogenerated file. Don't edit this file manually.
export interface themegenerateblock {
/**
* Name of the block
* @environment SHOPIFY_FLAG_BLOCK_NAME
*/
'-n, --name <value>'?: string

/**
* Disable color output.
* @environment SHOPIFY_FLAG_NO_COLOR
*/
'--no-color'?: ''

/**
* The path to your theme directory.
* @environment SHOPIFY_FLAG_PATH
*/
'--path <value>'?: string

/**
* Type of block to generate
* @environment SHOPIFY_FLAG_BLOCK_TYPE
*/
'-t, --type <value>'?: string

/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// This is an autogenerated file. Don't edit this file manually.
export interface themegeneratesection {
/**
* Name of the section
* @environment SHOPIFY_FLAG_SECTION_NAME
*/
'-n, --name <value>'?: string

/**
* Disable color output.
* @environment SHOPIFY_FLAG_NO_COLOR
*/
'--no-color'?: ''

/**
* The path to your theme directory.
* @environment SHOPIFY_FLAG_PATH
*/
'--path <value>'?: string

/**
* Type of section to generate
* @environment SHOPIFY_FLAG_SECTION_TYPE
*/
'-t, --type <value>'?: string

/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// This is an autogenerated file. Don't edit this file manually.
export interface themegeneratetemplate {
/**
* Name of the template
* @environment SHOPIFY_FLAG_TEMPLATE_NAME
*/
'-n, --name <value>'?: string

/**
* Disable color output.
* @environment SHOPIFY_FLAG_NO_COLOR
*/
'--no-color'?: ''

/**
* The path to your theme directory.
* @environment SHOPIFY_FLAG_PATH
*/
'--path <value>'?: string

/**
* Type of template to generate
* @environment SHOPIFY_FLAG_TEMPLATE_TYPE
*/
'-t, --type <value>'?: string

/**
* Increase the verbosity of the output.
* @environment SHOPIFY_FLAG_VERBOSE
*/
'--verbose'?: ''
}
38 changes: 38 additions & 0 deletions docs-shopify.dev/commands/theme-generate-block.doc.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// This is an autogenerated file. Don't edit this file manually.
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'

const data: ReferenceEntityTemplateSchema = {
name: 'theme generate block',
description: `Creates a new [theme block](/docs/themes/architecture/blocks) in your local theme directory.
The block is created in the \`blocks\` directory with the basic structure needed, including schema and settings.
You can specify the type of block to generate using the \`--type\` flag. The block will be created with appropriate default settings based on the type.`,
overviewPreviewDescription: `Creates and adds a new block file to your local theme directory`,
type: 'command',
isVisualComponent: false,
defaultExample: {
codeblock: {
tabs: [
{
title: 'theme generate block',
code: './examples/theme-generate-block.example.sh',
language: 'bash',
},
],
title: 'theme generate block',
},
},
definitions: [
{
title: 'Flags',
description: 'The following flags are available for the `theme generate block` command:',
type: 'themegenerateblock',
},
],
category: 'theme',
related: [
],
}

export default data
38 changes: 38 additions & 0 deletions docs-shopify.dev/commands/theme-generate-section.doc.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// This is an autogenerated file. Don't edit this file manually.
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'

const data: ReferenceEntityTemplateSchema = {
name: 'theme generate section',
description: `Creates a new [theme section](/docs/themes/architecture/sections) in your local theme directory.
The section is created in the \`sections\` directory with the basic structure needed, including schema, settings, and blocks.
You can specify the type of section to generate using the \`--type\` flag. The section will be created with appropriate default settings and blocks based on the type.`,
overviewPreviewDescription: `Creates and adds a new section file to your local theme directory`,
type: 'command',
isVisualComponent: false,
defaultExample: {
codeblock: {
tabs: [
{
title: 'theme generate section',
code: './examples/theme-generate-section.example.sh',
language: 'bash',
},
],
title: 'theme generate section',
},
},
definitions: [
{
title: 'Flags',
description: 'The following flags are available for the `theme generate section` command:',
type: 'themegeneratesection',
},
],
category: 'theme',
related: [
],
}

export default data
38 changes: 38 additions & 0 deletions docs-shopify.dev/commands/theme-generate-template.doc.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
// This is an autogenerated file. Don't edit this file manually.
import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'

const data: ReferenceEntityTemplateSchema = {
name: 'theme generate template',
description: `Creates a new [theme template](/docs/themes/architecture/templates) in your local theme directory.
The template is created in the \`templates\` directory with the basic structure needed, including layout and content sections.
You can specify the type of template to generate using the \`--type\` flag. The template will be created with appropriate default sections based on the type.`,
overviewPreviewDescription: `Creates and adds a new template file to your local theme directory`,
type: 'command',
isVisualComponent: false,
defaultExample: {
codeblock: {
tabs: [
{
title: 'theme generate template',
code: './examples/theme-generate-template.example.sh',
language: 'bash',
},
],
title: 'theme generate template',
},
},
definitions: [
{
title: 'Flags',
description: 'The following flags are available for the `theme generate template` command:',
type: 'themegeneratetemplate',
},
],
category: 'theme',
related: [
],
}

export default data
Loading

0 comments on commit 5b0886b

Please sign in to comment.