Showing preview only (2,676K chars total). Download the full file or copy to clipboard to get everything.
Repository: statamic/docs
Branch: 6.x
Commit: 7bf3cec2b499
Files: 939
Total size: 2.4 MB
Directory structure:
gitextract_4rmyxzvf/
├── .editorconfig
├── .gitattributes
├── .github/
│ └── FUNDING.yml
├── .gitignore
├── .nvmrc
├── LICENSE.md
├── README.md
├── app/
│ ├── Http/
│ │ ├── Controllers/
│ │ │ ├── Controller.php
│ │ │ ├── DocsMarkdownController.php
│ │ │ └── LlmsTxtController.php
│ │ └── Middleware/
│ │ └── CheckForMaintenanceMode.php
│ ├── Markdown/
│ │ ├── Hint/
│ │ │ ├── Hint.php
│ │ │ ├── HintExtension.php
│ │ │ ├── HintParser.php
│ │ │ ├── HintRenderer.php
│ │ │ └── HintStartParser.php
│ │ └── Tabs/
│ │ ├── TabbedCodeBlock.php
│ │ ├── TabbedCodeBlockExtension.php
│ │ ├── TabbedCodeStartParser.php
│ │ ├── TabsParser.php
│ │ └── TabsRenderer.php
│ ├── Models/
│ │ └── User.php
│ ├── Modifiers/
│ │ ├── Split.php
│ │ └── Toc.php
│ ├── Providers/
│ │ └── AppServiceProvider.php
│ ├── Search/
│ │ ├── DocTransformer.php
│ │ ├── Listeners/
│ │ │ └── SearchEntriesCreatedListener.php
│ │ ├── RequestContentRetriever.php
│ │ └── Storybook/
│ │ ├── StorybookSearchProvider.php
│ │ └── StorybookSearchable.php
│ ├── Tags/
│ │ ├── GithubCommitsUrl.php
│ │ ├── GithubEditUrl.php
│ │ └── HeroSponsors.php
│ └── ViewModels/
│ ├── Fieldtypes.php
│ ├── Modifiers.php
│ ├── Tags.php
│ └── Variables.php
├── artisan
├── bootstrap/
│ ├── app.php
│ ├── cache/
│ │ └── .gitignore
│ └── providers.php
├── composer.json
├── config/
│ ├── app.php
│ ├── auth.php
│ ├── cache.php
│ ├── database.php
│ ├── docs.php
│ ├── filesystems.php
│ ├── logging.php
│ ├── mail.php
│ ├── queue.php
│ ├── services.php
│ ├── session.php
│ ├── statamic/
│ │ ├── antlers.php
│ │ ├── api.php
│ │ ├── assets.php
│ │ ├── autosave.php
│ │ ├── cp.php
│ │ ├── editions.php
│ │ ├── forms.php
│ │ ├── git.php
│ │ ├── graphql.php
│ │ ├── live_preview.php
│ │ ├── markdown.php
│ │ ├── oauth.php
│ │ ├── protect.php
│ │ ├── revisions.php
│ │ ├── routes.php
│ │ ├── search.php
│ │ ├── stache.php
│ │ ├── static_caching.php
│ │ ├── system.php
│ │ ├── templates.php
│ │ ├── users.php
│ │ └── webauthn.php
│ └── torchlight.php
├── content/
│ ├── assets/
│ │ ├── .gitkeep
│ │ └── main.yaml
│ ├── collections/
│ │ ├── .gitkeep
│ │ ├── fieldtypes/
│ │ │ ├── array.md
│ │ │ ├── assets.md
│ │ │ ├── bard.md
│ │ │ ├── button_group.md
│ │ │ ├── checkboxes.md
│ │ │ ├── code.md
│ │ │ ├── collections.md
│ │ │ ├── color.md
│ │ │ ├── date.md
│ │ │ ├── dictionary.md
│ │ │ ├── entries.md
│ │ │ ├── float.md
│ │ │ ├── form.md
│ │ │ ├── grid.md
│ │ │ ├── group.md
│ │ │ ├── hidden.md
│ │ │ ├── html.md
│ │ │ ├── icon.md
│ │ │ ├── integer.md
│ │ │ ├── link.md
│ │ │ ├── list.md
│ │ │ ├── markdown.md
│ │ │ ├── navs.md
│ │ │ ├── radio.md
│ │ │ ├── range.md
│ │ │ ├── replicator.md
│ │ │ ├── revealer.md
│ │ │ ├── select.md
│ │ │ ├── sites.md
│ │ │ ├── slug.md
│ │ │ ├── spacer.md
│ │ │ ├── structures.md
│ │ │ ├── table.md
│ │ │ ├── taggable.md
│ │ │ ├── taxonomies.md
│ │ │ ├── template.md
│ │ │ ├── terms.md
│ │ │ ├── text.md
│ │ │ ├── textarea.md
│ │ │ ├── time.md
│ │ │ ├── toggle.md
│ │ │ ├── user-groups.md
│ │ │ ├── user-roles.md
│ │ │ ├── users.md
│ │ │ ├── video.md
│ │ │ ├── width.md
│ │ │ └── yaml.md
│ │ ├── fieldtypes.yaml
│ │ ├── modifiers/
│ │ │ ├── add.md
│ │ │ ├── add_slashes.md
│ │ │ ├── ampersand_list.md
│ │ │ ├── antlers.md
│ │ │ ├── as.md
│ │ │ ├── ascii.md
│ │ │ ├── at.md
│ │ │ ├── attribute.md
│ │ │ ├── background_position.md
│ │ │ ├── backspace.md
│ │ │ ├── bard_html.md
│ │ │ ├── bard_items.md
│ │ │ ├── bard_text.md
│ │ │ ├── bool_string.md
│ │ │ ├── camelize.md
│ │ │ ├── cdata.md
│ │ │ ├── ceil.md
│ │ │ ├── chunk.md
│ │ │ ├── classes.md
│ │ │ ├── collapse.md
│ │ │ ├── collapse_whitespace.md
│ │ │ ├── compact.md
│ │ │ ├── console_log.md
│ │ │ ├── contains.md
│ │ │ ├── contains_all.md
│ │ │ ├── contains_any.md
│ │ │ ├── count.md
│ │ │ ├── count_substring.md
│ │ │ ├── dashify.md
│ │ │ ├── days_ago.md
│ │ │ ├── decode.md
│ │ │ ├── deslugify.md
│ │ │ ├── divide.md
│ │ │ ├── dl.md
│ │ │ ├── doesnt_overlap.md
│ │ │ ├── dump.md
│ │ │ ├── embed_url.md
│ │ │ ├── ends_with.md
│ │ │ ├── ensure_left.md
│ │ │ ├── ensure_right.md
│ │ │ ├── entities.md
│ │ │ ├── excerpt.md
│ │ │ ├── explode.md
│ │ │ ├── favicon.md
│ │ │ ├── filter_empty.md
│ │ │ ├── first.md
│ │ │ ├── flatten.md
│ │ │ ├── flip.md
│ │ │ ├── floor.md
│ │ │ ├── folder.yaml
│ │ │ ├── format.md
│ │ │ ├── format_number.md
│ │ │ ├── format_translated.md
│ │ │ ├── full_urls.md
│ │ │ ├── get.md
│ │ │ ├── gravatar.md
│ │ │ ├── group_by.md
│ │ │ ├── has_lower_case.md
│ │ │ ├── has_upper_case.md
│ │ │ ├── headline.md
│ │ │ ├── hex_to_rgb.md
│ │ │ ├── hours_ago.md
│ │ │ ├── image.md
│ │ │ ├── in_array.md
│ │ │ ├── insert.md
│ │ │ ├── is_after.md
│ │ │ ├── is_alpha.md
│ │ │ ├── is_alphanumeric.md
│ │ │ ├── is_array.md
│ │ │ ├── is_before.md
│ │ │ ├── is_between.md
│ │ │ ├── is_blank.md
│ │ │ ├── is_email.md
│ │ │ ├── is_embeddable.md
│ │ │ ├── is_empty.md
│ │ │ ├── is_external_url.md
│ │ │ ├── is_future.md
│ │ │ ├── is_json.md
│ │ │ ├── is_leap_year.md
│ │ │ ├── is_lowercase.md
│ │ │ ├── is_numberwang.md
│ │ │ ├── is_numeric.md
│ │ │ ├── is_past.md
│ │ │ ├── is_today.md
│ │ │ ├── is_tomorrow.md
│ │ │ ├── is_uppercase.md
│ │ │ ├── is_url.md
│ │ │ ├── is_weekday.md
│ │ │ ├── is_weekend.md
│ │ │ ├── is_yesterday.md
│ │ │ ├── iso_format.md
│ │ │ ├── join.md
│ │ │ ├── kebab.md
│ │ │ ├── key_by.md
│ │ │ ├── keys.md
│ │ │ ├── last.md
│ │ │ ├── lcfirst.md
│ │ │ ├── length.md
│ │ │ ├── limit.md
│ │ │ ├── link.md
│ │ │ ├── list.md
│ │ │ ├── lower.md
│ │ │ ├── macro.md
│ │ │ ├── mailto.md
│ │ │ ├── mark.md
│ │ │ ├── markdown.md
│ │ │ ├── md5.md
│ │ │ ├── merge.md
│ │ │ ├── minutes_ago.md
│ │ │ ├── mod.md
│ │ │ ├── modify_date.md
│ │ │ ├── months_ago.md
│ │ │ ├── multiply.md
│ │ │ ├── nl2br.md
│ │ │ ├── obfuscate.md
│ │ │ ├── obfuscate_email.md
│ │ │ ├── offset.md
│ │ │ ├── ol.md
│ │ │ ├── option_list.md
│ │ │ ├── output.md
│ │ │ ├── overlaps.md
│ │ │ ├── pad.md
│ │ │ ├── parse_url.md
│ │ │ ├── partial.md
│ │ │ ├── pathinfo.md
│ │ │ ├── piped.md
│ │ │ ├── pluck.md
│ │ │ ├── plural.md
│ │ │ ├── random.md
│ │ │ ├── raw.md
│ │ │ ├── rawurlencode.md
│ │ │ ├── rawurlencode_except_slashes.md
│ │ │ ├── ray.md
│ │ │ ├── read_time.md
│ │ │ ├── regex_mark.md
│ │ │ ├── regex_replace.md
│ │ │ ├── relative.md
│ │ │ ├── remove_left.md
│ │ │ ├── remove_right.md
│ │ │ ├── repeat.md
│ │ │ ├── replace.md
│ │ │ ├── resolve.md
│ │ │ ├── reverse.md
│ │ │ ├── round.md
│ │ │ ├── safe_truncate.md
│ │ │ ├── sanitize.md
│ │ │ ├── scope.md
│ │ │ ├── seconds_ago.md
│ │ │ ├── segment.md
│ │ │ ├── select.md
│ │ │ ├── sentence_list.md
│ │ │ ├── shuffle.md
│ │ │ ├── singular.md
│ │ │ ├── slugify.md
│ │ │ ├── smartypants.md
│ │ │ ├── snake.md
│ │ │ ├── sort.md
│ │ │ ├── spaceless.md
│ │ │ ├── split.md
│ │ │ ├── starts_with.md
│ │ │ ├── str_pad_left.md
│ │ │ ├── strip_tags.md
│ │ │ ├── studly.md
│ │ │ ├── substr.md
│ │ │ ├── subtract.md
│ │ │ ├── sum.md
│ │ │ ├── surround.md
│ │ │ ├── swap_case.md
│ │ │ ├── table.md
│ │ │ ├── tidy.md
│ │ │ ├── timezone.md
│ │ │ ├── title.md
│ │ │ ├── to_json.md
│ │ │ ├── to_qs.md
│ │ │ ├── to_spaces.md
│ │ │ ├── to_tabs.md
│ │ │ ├── trans.md
│ │ │ ├── trim.md
│ │ │ ├── truncate.md
│ │ │ ├── ucfirst.md
│ │ │ ├── ul.md
│ │ │ ├── underscored.md
│ │ │ ├── unique.md
│ │ │ ├── upper.md
│ │ │ ├── url.md
│ │ │ ├── urldecode.md
│ │ │ ├── urlencode.md
│ │ │ ├── urlencode_except_slashes.md
│ │ │ ├── values.md
│ │ │ ├── weeks_ago.md
│ │ │ ├── where-in.md
│ │ │ ├── where.md
│ │ │ ├── widont.md
│ │ │ ├── word_count.md
│ │ │ ├── wrap.md
│ │ │ └── years_ago.md
│ │ ├── modifiers.yaml
│ │ ├── pages/
│ │ │ ├── 3-0-to-3-1.md
│ │ │ ├── 3-1-to-3-2.md
│ │ │ ├── 3-2-to-3-3.md
│ │ │ ├── 3-3-to-3-4.md
│ │ │ ├── 3-4-to-4-0.md
│ │ │ ├── 4-to-5.md
│ │ │ ├── 5-to-6.md
│ │ │ ├── actions.md
│ │ │ ├── addons.md
│ │ │ ├── advanced-topics.md
│ │ │ ├── all-fieldtypes.md
│ │ │ ├── all-modifiers.md
│ │ │ ├── all-tags.md
│ │ │ ├── all-variables.md
│ │ │ ├── all-widgets.md
│ │ │ ├── antlers.md
│ │ │ ├── assets.md
│ │ │ ├── augmentation.md
│ │ │ ├── backend-apis.md
│ │ │ ├── bard-v1-to-v2.md
│ │ │ ├── blade-form-fields.md
│ │ │ ├── blade.md
│ │ │ ├── blink-cache.md
│ │ │ ├── blueprints.md
│ │ │ ├── build-a-fieldtype.md
│ │ │ ├── building-a-tag.md
│ │ │ ├── building-a-widget.md
│ │ │ ├── building-an-addon.md
│ │ │ ├── caching.md
│ │ │ ├── cli.md
│ │ │ ├── code-of-conduct.md
│ │ │ ├── collections.md
│ │ │ ├── command-palette.md
│ │ │ ├── computed-values.md
│ │ │ ├── conditional-fields.md
│ │ │ ├── conditions.md
│ │ │ ├── configuration.md
│ │ │ ├── content-managers-guide.md
│ │ │ ├── content-modeling.md
│ │ │ ├── content-queries.md
│ │ │ ├── contributing.md
│ │ │ ├── contribution-guide.md
│ │ │ ├── control-panel.md
│ │ │ ├── controllers.md
│ │ │ ├── core-concepts.md
│ │ │ ├── cp-navigation.md
│ │ │ ├── cp-translations.md
│ │ │ ├── creating-a-starter-kit.md
│ │ │ ├── css-javascript.md
│ │ │ ├── customizing-the-cp-nav.md
│ │ │ ├── dashboard.md
│ │ │ ├── data-inheritance.md
│ │ │ ├── data.md
│ │ │ ├── debugging.md
│ │ │ ├── deploying.md
│ │ │ ├── dictionaries.md
│ │ │ ├── digital-ocean.md
│ │ │ ├── digitalocean.md
│ │ │ ├── dirty-state-tracking.md
│ │ │ ├── docker.md
│ │ │ ├── elevated-sessions.md
│ │ │ ├── email.md
│ │ │ ├── events.md
│ │ │ ├── field-actions.md
│ │ │ ├── fields.md
│ │ │ ├── fieldsets.md
│ │ │ ├── fieldtypes.1.md
│ │ │ ├── formatters.md
│ │ │ ├── forms.md
│ │ │ ├── fortrabbit.md
│ │ │ ├── from-wordpress-to-statamic.md
│ │ │ ├── frontend.md
│ │ │ ├── getting-started.md
│ │ │ ├── git-automation.md
│ │ │ ├── globals.md
│ │ │ ├── graphql.md
│ │ │ ├── home.md
│ │ │ ├── hooks.md
│ │ │ ├── image-manipulation.md
│ │ │ ├── installing-a-starter-kit.md
│ │ │ ├── installing.md
│ │ │ ├── javascript-frameworks.md
│ │ │ ├── js-events.md
│ │ │ ├── js-hooks.md
│ │ │ ├── keyboard-shortcuts.md
│ │ │ ├── knowledge-base.md
│ │ │ ├── laravel-7-to-8.md
│ │ │ ├── laravel-cloud.md
│ │ │ ├── laravel-forge-1-click.md
│ │ │ ├── laravel-forge.md
│ │ │ ├── laravel-herd.md
│ │ │ ├── laravel.md
│ │ │ ├── licensing.md
│ │ │ ├── lifecycle.md
│ │ │ ├── linode.md
│ │ │ ├── live-preview.md
│ │ │ ├── local.md
│ │ │ ├── markdown.md
│ │ │ ├── modifiers.1.md
│ │ │ ├── modifiers.md
│ │ │ ├── multi-site.md
│ │ │ ├── multi-user-collaboration.md
│ │ │ ├── navigation.md
│ │ │ ├── netlify.md
│ │ │ ├── oauth.md
│ │ │ ├── overview.1.md
│ │ │ ├── overview.10.md
│ │ │ ├── overview.12.md
│ │ │ ├── overview.2.md
│ │ │ ├── overview.3.md
│ │ │ ├── overview.4.md
│ │ │ ├── overview.5.md
│ │ │ ├── overview.6.md
│ │ │ ├── overview.7.md
│ │ │ ├── overview.8.md
│ │ │ ├── overview.md
│ │ │ ├── permissions.md
│ │ │ ├── ploi.md
│ │ │ ├── preferences.md
│ │ │ ├── progress.md
│ │ │ ├── protecting-content.md
│ │ │ ├── publish-forms.md
│ │ │ ├── query-scopes-and-filters.md
│ │ │ ├── quick-start-guide.md
│ │ │ ├── relationship-fieldtypes.md
│ │ │ ├── relationships.md
│ │ │ ├── release-schedule-support-policy.md
│ │ │ ├── repositories.md
│ │ │ ├── requirements.md
│ │ │ ├── resource-apis.md
│ │ │ ├── rest-api.md
│ │ │ ├── revisions.md
│ │ │ ├── routing.1.md
│ │ │ ├── routing.md
│ │ │ ├── scheduling.md
│ │ │ ├── search.md
│ │ │ ├── sites-api.md
│ │ │ ├── slugs.md
│ │ │ ├── stache.md
│ │ │ ├── starter-kits.md
│ │ │ ├── static-caching.md
│ │ │ ├── structures.md
│ │ │ ├── tags.md
│ │ │ ├── taxonomies.md
│ │ │ ├── testing.md
│ │ │ ├── tips.md
│ │ │ ├── toast-notifications.md
│ │ │ ├── troubleshooting.md
│ │ │ ├── ubuntu.md
│ │ │ ├── ui-components.md
│ │ │ ├── updating-a-starter-kit.md
│ │ │ ├── updating.md
│ │ │ ├── upgrade-guide.md
│ │ │ ├── users.md
│ │ │ ├── utilities.md
│ │ │ ├── v2-to-v3.md
│ │ │ ├── validation.md
│ │ │ ├── variables.md
│ │ │ ├── vercel.md
│ │ │ ├── view-models.md
│ │ │ ├── views.md
│ │ │ ├── vite-tooling.md
│ │ │ ├── vue-2-to-3.md
│ │ │ ├── vue-components.md
│ │ │ ├── white-labeling.md
│ │ │ ├── widgets.md
│ │ │ └── yaml.md
│ │ ├── pages.yaml
│ │ ├── resource_apis/
│ │ │ ├── asset-container-repository.md
│ │ │ ├── asset-repository.md
│ │ │ ├── collection-repository.md
│ │ │ ├── entry-repository.md
│ │ │ ├── form-repository.md
│ │ │ ├── form-submission-repository.md
│ │ │ ├── global-repository.md
│ │ │ ├── site-repository.md
│ │ │ ├── taxonomy-repository.md
│ │ │ ├── term-repository.md
│ │ │ ├── user-group-repository.md
│ │ │ ├── user-repository.md
│ │ │ └── user-role-repository.md
│ │ ├── resource_apis.yaml
│ │ ├── tags/
│ │ │ ├── 404.md
│ │ │ ├── asset.md
│ │ │ ├── assets.md
│ │ │ ├── cache.md
│ │ │ ├── children.md
│ │ │ ├── collection-count.md
│ │ │ ├── collection-next.md
│ │ │ ├── collection-previous.md
│ │ │ ├── collection.md
│ │ │ ├── cookie.md
│ │ │ ├── dictionary.md
│ │ │ ├── dump.md
│ │ │ ├── foreach.md
│ │ │ ├── form-create.md
│ │ │ ├── form-errors.md
│ │ │ ├── form-fields.md
│ │ │ ├── form-set.md
│ │ │ ├── form-submission.md
│ │ │ ├── form-submissions.md
│ │ │ ├── form-success.md
│ │ │ ├── form.md
│ │ │ ├── get_content.md
│ │ │ ├── get_error.md
│ │ │ ├── get_errors.md
│ │ │ ├── get_files.md
│ │ │ ├── get_site.md
│ │ │ ├── glide-batch.md
│ │ │ ├── glide-data-url.md
│ │ │ ├── glide.md
│ │ │ ├── increment.md
│ │ │ ├── installed.md
│ │ │ ├── link.md
│ │ │ ├── locales-count.md
│ │ │ ├── locales.md
│ │ │ ├── loop.md
│ │ │ ├── markdown-indent.md
│ │ │ ├── markdown.md
│ │ │ ├── mix.md
│ │ │ ├── mount_url.md
│ │ │ ├── nav-breadcrumbs.md
│ │ │ ├── nav.md
│ │ │ ├── nocache.md
│ │ │ ├── oauth.md
│ │ │ ├── obfuscate.md
│ │ │ ├── parent.md
│ │ │ ├── partial-exists.md
│ │ │ ├── partial-if-exists.md
│ │ │ ├── partial.md
│ │ │ ├── protect-password_form.md
│ │ │ ├── redirect.md
│ │ │ ├── route.md
│ │ │ ├── scope.md
│ │ │ ├── search.md
│ │ │ ├── section.md
│ │ │ ├── session-dump.md
│ │ │ ├── session-flash.md
│ │ │ ├── session-flush.md
│ │ │ ├── session-forget.md
│ │ │ ├── session-has.md
│ │ │ ├── session-set.md
│ │ │ ├── session.md
│ │ │ ├── svg.md
│ │ │ ├── switch.md
│ │ │ ├── taxonomy-count.md
│ │ │ ├── taxonomy.md
│ │ │ ├── trans.md
│ │ │ ├── user-can.md
│ │ │ ├── user-delete_passkey_form.md
│ │ │ ├── user-disable_two_factor_form.md
│ │ │ ├── user-elevated_session_form.md
│ │ │ ├── user-forgot_password_form.md
│ │ │ ├── user-groups.md
│ │ │ ├── user-in.md
│ │ │ ├── user-is.md
│ │ │ ├── user-login_form.md
│ │ │ ├── user-logout.md
│ │ │ ├── user-logout_url.md
│ │ │ ├── user-passkey_form.md
│ │ │ ├── user-passkeys.md
│ │ │ ├── user-password_form.md
│ │ │ ├── user-profile.md
│ │ │ ├── user-profile_form.md
│ │ │ ├── user-register_form.md
│ │ │ ├── user-reset_password_form.md
│ │ │ ├── user-reset_two_factor_recovery_codes_form.md
│ │ │ ├── user-roles.md
│ │ │ ├── user-two_factor_challenge_form.md
│ │ │ ├── user-two_factor_enable_form.md
│ │ │ ├── user-two_factor_enabled.md
│ │ │ ├── user-two_factor_recovery_codes.md
│ │ │ ├── user-two_factor_recovery_codes_download_url.md
│ │ │ ├── user-two_factor_setup_form.md
│ │ │ ├── users.md
│ │ │ ├── vite-content.md
│ │ │ ├── vite.md
│ │ │ └── yield.md
│ │ ├── tags.yaml
│ │ ├── tips/
│ │ │ ├── building-your-own-entries-repository.md
│ │ │ ├── change-timezone-to-utc.md
│ │ │ ├── configuring-update-scripts.md
│ │ │ ├── content-security-policy.md
│ │ │ ├── converting-from-single-to-multi-site.md
│ │ │ ├── creating-users-by-hand.md
│ │ │ ├── digital-ocean-spaces-for-asset-container.md
│ │ │ ├── disabling-cp-authentication.md
│ │ │ ├── excluding-the-control-panel-from-maintenance-mode.md
│ │ │ ├── gdpr-considerations.md
│ │ │ ├── git-workflow.md
│ │ │ ├── how-to-enable-statamic-pro.md
│ │ │ ├── importing-content.md
│ │ │ ├── laravel-nova.md
│ │ │ ├── load-templates-dynamically-based-on-the-url.md
│ │ │ ├── localizing-entries.md
│ │ │ ├── localizing-globals.md
│ │ │ ├── localizing-navigation.md
│ │ │ ├── manually-resetting-a-user-password.md
│ │ │ ├── optimizing-assets.md
│ │ │ ├── overriding-exception-rendering.md
│ │ │ ├── pushing-related-entries-to-an-algolia-index.md
│ │ │ ├── recursive-nav-examples.md
│ │ │ ├── reserved-words.md
│ │ │ ├── setting-default-listing-columns.md
│ │ │ ├── storing-content-in-a-database.md
│ │ │ ├── storing-laravel-users-in-files.md
│ │ │ ├── storing-users-in-a-database.md
│ │ │ ├── storing-users-somewhere-custom.md
│ │ │ ├── taxonomies-by-hand.md
│ │ │ ├── timezones.md
│ │ │ ├── trailing-slashes.md
│ │ │ ├── using-an-independent-authentication-guard.md
│ │ │ ├── using-statamic-with-laravel-nightwatch.md
│ │ │ └── zero-downtime-deployments.md
│ │ ├── tips.yaml
│ │ ├── troubleshooting/
│ │ │ ├── asset-permissions.md
│ │ │ ├── assets-missing-urls.md
│ │ │ ├── command-not-found-statamic.md
│ │ │ ├── composer-and-github-authentication.md
│ │ │ ├── control-panel-page-expired.md
│ │ │ ├── email-not-sending.md
│ │ │ ├── fixing-issues-with-global-composer-packages.md
│ │ │ ├── listing-performance.md
│ │ │ ├── missing-control-panel-assets.md
│ │ │ └── required-php-extensions.md
│ │ ├── troubleshooting.yaml
│ │ ├── variables/
│ │ │ ├── basename.md
│ │ │ ├── collection.md
│ │ │ ├── config.md
│ │ │ ├── csrf_field.md
│ │ │ ├── csrf_token.md
│ │ │ ├── current_layout.md
│ │ │ ├── current_template.md
│ │ │ ├── current_uri.md
│ │ │ ├── current_url.md
│ │ │ ├── current_user.md
│ │ │ ├── date.md
│ │ │ ├── datestamp.md
│ │ │ ├── datestring.md
│ │ │ ├── edit_url.md
│ │ │ ├── entries_count.md
│ │ │ ├── environment.md
│ │ │ ├── extension.md
│ │ │ ├── filename.md
│ │ │ ├── focus.md
│ │ │ ├── focus_css.md
│ │ │ ├── folder.yaml
│ │ │ ├── get.md
│ │ │ ├── get_post.md
│ │ │ ├── has_timestamp.md
│ │ │ ├── height.md
│ │ │ ├── homepage.md
│ │ │ ├── id.md
│ │ │ ├── is_asset.md
│ │ │ ├── is_entry.md
│ │ │ ├── is_homepage.md
│ │ │ ├── is_image.md
│ │ │ ├── is_term.md
│ │ │ ├── is_video.md
│ │ │ ├── last_modified.md
│ │ │ ├── last_segment.md
│ │ │ ├── live_preview.md
│ │ │ ├── logged_in.md
│ │ │ ├── now.md
│ │ │ ├── old.md
│ │ │ ├── order.md
│ │ │ ├── order_type.md
│ │ │ ├── path.md
│ │ │ ├── permalink.md
│ │ │ ├── post.md
│ │ │ ├── published.md
│ │ │ ├── response_code.md
│ │ │ ├── segment_x.md
│ │ │ ├── site.md
│ │ │ ├── sites.md
│ │ │ ├── size.md
│ │ │ ├── size_bytes.md
│ │ │ ├── size_gigabytes.md
│ │ │ ├── size_kilobytes.md
│ │ │ ├── size_megabytes.md
│ │ │ ├── slug.md
│ │ │ ├── taxonomy.md
│ │ │ ├── timestamp.md
│ │ │ ├── url.md
│ │ │ ├── width.md
│ │ │ └── xml_header.md
│ │ ├── variables.yaml
│ │ ├── widgets/
│ │ │ ├── collection.md
│ │ │ ├── form.md
│ │ │ └── updater.md
│ │ └── widgets.yaml
│ ├── globals/
│ │ ├── .gitkeep
│ │ ├── default/
│ │ │ └── global.yaml
│ │ └── global.yaml
│ ├── navigation/
│ │ └── .gitkeep
│ ├── structures/
│ │ └── .gitkeep
│ ├── taxonomies/
│ │ ├── .gitkeep
│ │ ├── categories/
│ │ │ ├── cli.yaml
│ │ │ ├── database.yaml
│ │ │ ├── development.yaml
│ │ │ ├── devops.yaml
│ │ │ ├── laravel.yaml
│ │ │ ├── localization.yaml
│ │ │ ├── performance.yaml
│ │ │ ├── privacy-gdpr.yaml
│ │ │ └── troubleshooting.yaml
│ │ ├── categories.yaml
│ │ ├── modifier_types.yaml
│ │ ├── tags/
│ │ │ └── beginner.yaml
│ │ ├── tags.yaml
│ │ ├── types/
│ │ │ ├── asset.yaml
│ │ │ ├── content.yaml
│ │ │ ├── entry.yaml
│ │ │ ├── system.yaml
│ │ │ └── term.yaml
│ │ └── types.yaml
│ └── trees/
│ ├── collections/
│ │ └── pages.yaml
│ └── navigation/
│ ├── docs.yaml
│ ├── extending_docs.yaml
│ ├── guides.yaml
│ ├── reference.yaml
│ ├── screencasts.yaml
│ ├── sections.yaml
│ └── top.yaml
├── database/
│ ├── .gitignore
│ ├── factories/
│ │ └── UserFactory.php
│ ├── migrations/
│ │ ├── 0001_01_01_000000_create_users_table.php
│ │ ├── 0001_01_01_000001_create_cache_table.php
│ │ └── 0001_01_01_000002_create_jobs_table.php
│ └── seeders/
│ └── DatabaseSeeder.php
├── lang/
│ └── en/
│ └── validation.php
├── package.json
├── phpunit.xml
├── please
├── postcss.config.js
├── public/
│ ├── .htaccess
│ ├── favicons/
│ │ └── site.webmanifest
│ ├── img/
│ │ ├── adverts/
│ │ │ └── .gitkeep
│ │ ├── navigation/
│ │ │ └── .gitkeep
│ │ ├── pro-badges/
│ │ │ ├── .gitkeep
│ │ │ ├── artwork/
│ │ │ │ └── .gitkeep
│ │ │ └── icons/
│ │ │ └── .gitkeep
│ │ └── tiles/
│ │ └── .gitkeep
│ ├── index.php
│ ├── mix-manifest.json
│ └── robots.txt
├── resources/
│ ├── blueprints/
│ │ ├── collections/
│ │ │ ├── adverts/
│ │ │ │ └── advert.yaml
│ │ │ ├── extending-docs/
│ │ │ │ └── page.yaml
│ │ │ ├── fieldtypes/
│ │ │ │ └── fieldtype.yaml
│ │ │ ├── guides/
│ │ │ │ └── guides.yaml
│ │ │ ├── knowledge-base/
│ │ │ │ └── page.yaml
│ │ │ ├── modifiers/
│ │ │ │ └── modifiers.yaml
│ │ │ ├── pages/
│ │ │ │ ├── home.yaml
│ │ │ │ ├── link.yaml
│ │ │ │ └── page.yaml
│ │ │ ├── reference/
│ │ │ │ └── reference.yaml
│ │ │ ├── references/
│ │ │ │ └── references.yaml
│ │ │ ├── resource_apis/
│ │ │ │ └── resource_apis.yaml
│ │ │ ├── screencasts/
│ │ │ │ └── screencasts.yaml
│ │ │ ├── sections/
│ │ │ │ └── sections.yaml
│ │ │ ├── tags/
│ │ │ │ ├── tag-glide.yaml
│ │ │ │ └── tag.yaml
│ │ │ ├── tips/
│ │ │ │ └── tips.yaml
│ │ │ ├── troubleshooting/
│ │ │ │ └── troubleshooting.yaml
│ │ │ ├── ui_components/
│ │ │ │ └── ui_component.yaml
│ │ │ ├── variables/
│ │ │ │ └── variables.yaml
│ │ │ └── widgets/
│ │ │ └── widgets.yaml
│ │ ├── globals/
│ │ │ └── global.yaml
│ │ ├── navigation/
│ │ │ ├── docs.yaml
│ │ │ ├── extending_docs.yaml
│ │ │ └── reference.yaml
│ │ └── taxonomies/
│ │ └── categories/
│ │ └── categories.yaml
│ ├── css/
│ │ ├── -template.css
│ │ ├── README.css
│ │ ├── base/
│ │ │ ├── cp.css
│ │ │ ├── elements/
│ │ │ │ ├── elements.css
│ │ │ │ └── tables.css
│ │ │ ├── reset.css
│ │ │ └── variables.css
│ │ ├── components/
│ │ │ ├── anchors.css
│ │ │ ├── buttons.css
│ │ │ ├── doc-tabs.css
│ │ │ ├── docs-header.css
│ │ │ ├── entry-content.css
│ │ │ ├── feedback-meerkat.css
│ │ │ ├── icon-grid.css
│ │ │ ├── imagery/
│ │ │ │ ├── bordered-image.css
│ │ │ │ └── full-width-image.css
│ │ │ ├── list-turtles.css
│ │ │ ├── logos.css
│ │ │ ├── nav/
│ │ │ │ ├── back-nav.css
│ │ │ │ ├── breadcrumbs.css
│ │ │ │ ├── sidebar-advert.css
│ │ │ │ ├── sidebar.css
│ │ │ │ └── toc.css
│ │ │ ├── panel-list.css
│ │ │ ├── pill-with-description.css
│ │ │ ├── pill.css
│ │ │ ├── pro-badge.css
│ │ │ ├── promo.css
│ │ │ ├── quirky.css
│ │ │ ├── related.css
│ │ │ ├── search-form.css
│ │ │ ├── site-footer.css
│ │ │ ├── skip-to-content.css
│ │ │ ├── syntax-explainer.css
│ │ │ ├── theme-picker.css
│ │ │ ├── tiles-with-description.css
│ │ │ ├── tip.css
│ │ │ ├── version-selector.css
│ │ │ └── video.css
│ │ ├── objects/
│ │ │ ├── badge-heading.css
│ │ │ ├── collapsible-side-menu-with-checkboxes.css
│ │ │ ├── entry-content.css
│ │ │ ├── scroll-shadows.css
│ │ │ └── toc-scroll-spy.css
│ │ ├── style.css
│ │ ├── torchlight.css
│ │ └── utilities/
│ │ ├── animation-keyframes.css
│ │ ├── hiders.css
│ │ ├── label.css
│ │ └── utilities.css
│ ├── fieldsets/
│ │ ├── advert_override.yaml
│ │ ├── common.yaml
│ │ ├── hue_rotate.yaml
│ │ ├── navigation.yaml
│ │ └── page.yaml
│ ├── js/
│ │ ├── anchors.js
│ │ ├── color-scheme-preferences.js
│ │ ├── cookies.js
│ │ ├── dayjs.js
│ │ ├── dl.js
│ │ ├── docsearch.js
│ │ ├── external-links.js
│ │ ├── language-badges.js
│ │ ├── site.js
│ │ ├── tables.js
│ │ ├── toc-navigation.js
│ │ └── torchlight.js
│ ├── sites.yaml
│ ├── users/
│ │ ├── groups.yaml
│ │ └── roles.yaml
│ └── views/
│ ├── default.antlers.html
│ ├── deploying.antlers.html
│ ├── documentation-search/
│ │ ├── docs/
│ │ │ └── page.antlers.html
│ │ ├── extending-docs/
│ │ │ └── page.antlers.html
│ │ ├── fieldtypes/
│ │ │ └── fieldtype.antlers.html
│ │ ├── modifiers/
│ │ │ └── modifiers.antlers.html
│ │ ├── reference/
│ │ │ └── reference.antlers.html
│ │ ├── repositories/
│ │ │ └── repositories.antlers.html
│ │ ├── screencasts/
│ │ │ └── screencasts.antlers.html
│ │ ├── sections/
│ │ │ └── sections.antlers.html
│ │ ├── tags/
│ │ │ ├── tag-glide.antlers.html
│ │ │ └── tag.antlers.html
│ │ ├── tips/
│ │ │ └── tips.antlers.html
│ │ ├── troubleshooting/
│ │ │ └── troubleshooting.antlers.html
│ │ ├── variables/
│ │ │ └── variables.antlers.html
│ │ └── widgets/
│ │ └── widgets.antlers.html
│ ├── errors/
│ │ └── 404.antlers.html
│ ├── extending/
│ │ └── index.antlers.html
│ ├── fieldtypes/
│ │ └── index.antlers.html
│ ├── home.antlers.html
│ ├── image_dimensions/
│ │ ├── navigation_image.antlers.html
│ │ └── tile.antlers.html
│ ├── installing.antlers.html
│ ├── layout.antlers.html
│ ├── listing.antlers.html
│ ├── modifiers/
│ │ └── index.antlers.html
│ ├── page.antlers.html
│ ├── partials/
│ │ ├── details.antlers.html
│ │ ├── edit.antlers.html
│ │ ├── favicons.antlers.html
│ │ ├── footer.antlers.html
│ │ ├── head.antlers.html
│ │ ├── header.antlers.html
│ │ ├── lorem.antlers.html
│ │ ├── meta.antlers.html
│ │ ├── nav_contents.antlers.html
│ │ ├── nav_sidebar.antlers.html
│ │ ├── promo.antlers.html
│ │ ├── related.antlers.html
│ │ ├── scripts.antlers.html
│ │ ├── sidebar-promo.antlers.html
│ │ ├── site_header.antlers.html
│ │ ├── suggest.antlers.html
│ │ └── variables.antlers.html
│ ├── reference/
│ │ └── index.antlers.html
│ ├── repositories/
│ │ └── index.antlers.html
│ ├── search.antlers.html
│ ├── sitemap.antlers.html
│ ├── social.antlers.html
│ ├── tabs.antlers.html
│ ├── tags/
│ │ ├── glide.antlers.html
│ │ └── index.antlers.html
│ ├── tips/
│ │ └── index.antlers.html
│ ├── troubleshooting/
│ │ └── index.antlers.html
│ ├── updates.antlers.html
│ └── variables/
│ └── index.antlers.html
├── routes/
│ ├── console.php
│ ├── redirects.php
│ └── web.php
├── server.php
├── storage/
│ ├── app/
│ │ └── .gitignore
│ ├── framework/
│ │ ├── .gitignore
│ │ ├── cache/
│ │ │ └── .gitignore
│ │ ├── sessions/
│ │ │ └── .gitignore
│ │ ├── testing/
│ │ │ └── .gitignore
│ │ └── views/
│ │ └── .gitignore
│ ├── logs/
│ │ └── .gitignore
│ └── statamic/
│ └── .gitignore
├── tests/
│ ├── CreatesApplication.php
│ ├── Feature/
│ │ └── ExampleTest.php
│ ├── TestCase.php
│ └── Unit/
│ └── ExampleTest.php
└── vite.config.js
================================================
FILE CONTENTS
================================================
================================================
FILE: .editorconfig
================================================
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 4
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
[*.yml]
indent_size = 2
================================================
FILE: .gitattributes
================================================
* text=auto
*.css linguist-vendored
*.scss linguist-vendored
*.js linguist-vendored
CHANGELOG.md export-ignore
================================================
FILE: .github/FUNDING.yml
================================================
github: statamic
================================================
FILE: .gitignore
================================================
.DS_Store
/node_modules
/public/hot
/public/storage
/public/vendor/statamic
/public/build/*
/users/*
/public/js
/public/css/scratch.css
/storage/*.key
/storage/statamic/users
/storage/debugbar/*
/storage/glide/*
/storage/antlers-language-server/*
/storage/stillat/*
/vendor
.env
.env.backup
.phpunit.result.cache
Homestead.json
Homestead.yaml
npm-debug.log
yarn-error.log
# When in dev...
/public/**/.meta
.antlers.json
================================================
FILE: .nvmrc
================================================
22
================================================
FILE: LICENSE.md
================================================
Copyright © Statamic, LLC.
Permission is hereby granted to any person obtaining a copy of this software (the “Software”) to use, copy, modify, merge, publish and/or distribute copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
1. **Do not plagiarize.** The above copyright notice and this license shall be included in all copies or substantial portions of the Software.
2. **Do not use the same license on more than one project.** Each licensed copy of the Software shall be actively installed in no more than one production environment at a time.
3. **Do not alter the licensing features.** Software features related to licensing shall not be altered or circumvented in any way, including (but not limited to) license validation, feature or edition restrictions, and update eligibility.
4. **Follow the law.** All use of the Software shall not violate any applicable law or regulation, nor infringe the rights of any other person or entity.
Failure to comply with the foregoing conditions will automatically and immediately result in termination of the permission granted hereby. This license does not include any right to receive updates to the Software or technical support. Licensees bear all risk related to the quality and
performance of the Software and any modifications made or obtained to it, including liability for actual and consequential harm, such as loss or corruption of data, and any necessary service, repair, or correction.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, INCLUDING SPECIAL, INCIDENTAL AND CONSEQUENTIAL DAMAGES, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
================================================
FILE: README.md
================================================
<p align="center"><img src="https://statamic.com/assets/branding/Statamic-Logo+Wordmark-Rad.svg" width="400" alt="Statamic Logo" /></p>
## Statamic Documentation
This is the source of the official [Statamic docs][docs].
## Local Development
If you want to work on this project on your local machine, you may follow the instructions below. These instructions assume you are serving the site using [Laravel Valet](https://laravel.com/docs/valet) out of your `~/Sites` directory:
1. Fork this repository
2. Open your terminal and cd to your `~/Sites` folder
3. Clone your fork into the `~/Sites/docs` folder, by running the following command with your username placed into the {username} slot:
```
git clone git@github.com:{username}/docs statamic-docs
```
4. CD into the new directory you just created.
5. Run the following commands:
```
composer install
npm install
npm run dev
cp .env.example .env
php artisan key:generate
```
## Providing Feedback
We love it when people provide thoughtful feedback! Feel free to open issues on for any content you find confusing or incomplete. We are happy to consider anything you feel will make the docs and CMS better.
## Contributing
Thank you for considering contributing to Statamic! Every page in the [docs site](https://statamic.dev) has a link at the bottom that will take you right to the exact content file that renders the page. Click the edit button and submit those PRs!
**We simply ask that you please review the [contribution guide][contribution] before you send pull requests.**
## Code of Conduct
In order to ensure that the Statamic community is welcoming to all and generally a rad place to belong, please review and abide by the [Code of Conduct](https://github.com/statamic/cms/wiki/Code-of-Conduct).
## Important Links
- [Statamic Main Site](https://statamic.com)
- [Statamic Documentation][docs]
- [Statamic CMS Repo][cms-repo] (that we maintain)
- [Statamic Application Repo][app-repo] (that you clone)
- [Statamic Migrator](https://github.com/statamic/migrator)
- [Statamic Discord][discord]
[docs]: https://statamic.dev/
[discord]: https://statamic.com/discord
[contribution]: https://github.com/statamic/cms/blob/master/CONTRIBUTING.md
[app-repo]: https://github.com/statamic/statamic
[cms-repo]: https://github.com/statamic/cms
================================================
FILE: app/Http/Controllers/Controller.php
================================================
<?php
namespace App\Http\Controllers;
use Illuminate\Foundation\Auth\Access\AuthorizesRequests;
use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Routing\Controller as BaseController;
class Controller extends BaseController
{
use AuthorizesRequests, DispatchesJobs, ValidatesRequests;
}
================================================
FILE: app/Http/Controllers/DocsMarkdownController.php
================================================
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Cache;
use Statamic\Exceptions\NotFoundHttpException;
use Statamic\Facades\Data;
class DocsMarkdownController extends Controller
{
public function __invoke(string $uri)
{
$markdown = Cache::rememberForever("markdown.$uri", function () use ($uri) {
$entry = Data::findByUri('/'.$uri);
throw_unless($entry, new NotFoundHttpException);
return collect([
'# '.$entry->value('title'),
$entry->value('intro'),
$entry->value('content'),
])->filter()->implode("\n\n");
});
$markdown = $this->appendMdExtensionToInternalLinks($markdown);
return response($markdown, 200, [
'Content-Type' => 'text/markdown; charset=UTF-8',
]);
}
private function appendMdExtensionToInternalLinks(string $markdown): string
{
return preg_replace_callback(
'/(?<!!)\[([^\]]+)\]\(([^)]+)\)/',
function ($matches) {
$text = $matches[1];
$url = $matches[2];
if ($this->shouldAppendMdExtension($url)) {
$url .= '.md';
}
return "[$text]($url)";
},
$markdown
);
}
private function shouldAppendMdExtension(string $url): bool
{
if (preg_match('/^https?:\/\//', $url)) {
return false;
}
if (preg_match('/\.[a-z0-9]{2,4}$/i', $url)) {
return false;
}
return true;
}
}
================================================
FILE: app/Http/Controllers/LlmsTxtController.php
================================================
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Cache;
use Statamic\Facades\Collection;
use Statamic\Facades\Entry;
class LlmsTxtController extends Controller
{
public function __invoke()
{
$lines = Cache::rememberForever("llms.txt", function () {
$tree = Collection::find('pages')->structure()->trees()->first()->tree();
$lines = ['# Statamic Documentation', ''];
foreach ($tree as $section) {
$children = $section['children'] ?? [];
if (! $children) {
continue;
}
$sectionEntry = Entry::find($section['entry']);
$lines[] = '## '.$sectionEntry->value('title');
$firstChild = Entry::find($children[0]['entry']);
if ($firstChild && str_contains($firstChild->slug(), 'overview')) {
if ($intro = $firstChild->value('intro')) {
$lines[] = '> '.str_replace("\n", ' ', $intro);
}
}
$lines[] = '';
foreach ($children as $child) {
$entry = Entry::find($child['entry']);
if (! $entry) {
continue;
}
$url = $entry->url();
if (! $url) {
continue;
}
$title = $entry->value('title');
$isExternal = str_starts_with($url, 'http');
$href = $isExternal ? $url : url($url).'.md';
$line = '- ['.$title.']('.$href.')';
if ($intro = $entry->value('intro')) {
$line .= ': '.str_replace("\n", ' ', $intro);
}
$lines[] = $line;
}
$lines[] = '';
}
return $lines;
});
return response(implode("\n", $lines), 200, [
'Content-Type' => 'text/plain; charset=UTF-8',
]);
}
}
================================================
FILE: app/Http/Middleware/CheckForMaintenanceMode.php
================================================
<?php
namespace App\Http\Middleware;
use Illuminate\Foundation\Http\Middleware\CheckForMaintenanceMode as Middleware;
class CheckForMaintenanceMode extends Middleware
{
/**
* The URIs that should be reachable while maintenance mode is enabled.
*
* @var array
*/
protected $except = [
//
];
}
================================================
FILE: app/Markdown/Hint/Hint.php
================================================
<?php
namespace App\Markdown\Hint;
use League\CommonMark\Node\Block\AbstractBlock;
use League\CommonMark\Node\StringContainerInterface;
class Hint extends AbstractBlock implements StringContainerInterface
{
private ?string $header = 'Hot Tip!';
protected string $literal;
public function getTitle(): ?string
{
$words = $this->getHeaderWords();
if (count($words) > 1) {
array_shift($words);
return implode(' ', $words);
}
if ($words[0] === 'tip') {
return 'Hot Tip!';
}
if ($words[0] === 'hint') {
return 'Hinty Hint!';
}
if ($words[0] === 'warning') {
return 'Warning!';
}
if ($words[0] === 'best-practice') {
return 'Best Practice';
}
return null;
}
public function getType(): ?string
{
$words = $this->getHeaderWords();
if (count($words) > 0) {
return $words[0];
}
return null;
}
public function getHeaderWords(): array
{
return \preg_split('/\s+/', $this->header ?? '') ?: [];
}
public function setHeader($header)
{
$this->header = $header;
}
public function setLiteral(string $literal): void
{
$this->literal = $literal;
}
public function getLiteral(): string
{
return $this->literal;
}
}
================================================
FILE: app/Markdown/Hint/HintExtension.php
================================================
<?php
namespace App\Markdown\Hint;
use League\CommonMark\Environment\EnvironmentBuilderInterface;
use League\CommonMark\Extension\ExtensionInterface;
class HintExtension implements ExtensionInterface
{
public function register(EnvironmentBuilderInterface $environment): void
{
$environment->addBlockStartParser(new HintStartParser);
$environment->addRenderer(Hint::class, new HintRenderer);
}
}
================================================
FILE: app/Markdown/Hint/HintParser.php
================================================
<?php
namespace App\Markdown\Hint;
use League\CommonMark\Node\Block\AbstractBlock;
use League\CommonMark\Parser\Block\AbstractBlockContinueParser;
use League\CommonMark\Parser\Block\BlockContinue;
use League\CommonMark\Parser\Block\BlockContinueParserInterface;
use League\CommonMark\Parser\Cursor;
class HintParser extends AbstractBlockContinueParser implements BlockContinueParserInterface
{
private Hint $block;
public function __construct(?string $headerText)
{
$this->block = new Hint;
$this->block->setHeader($headerText);
}
public function getBlock(): Hint
{
return $this->block;
}
public function isContainer(): bool
{
return true;
}
public function canContain(AbstractBlock $childBlock): bool
{
return true;
}
public function canHaveLazyContinuationLines(): bool
{
return false;
}
public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
{
if ($cursor->getLine() === ':::') {
return BlockContinue::finished();
}
return BlockContinue::at($cursor);
}
}
================================================
FILE: app/Markdown/Hint/HintRenderer.php
================================================
<?php
namespace App\Markdown\Hint;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Renderer\NodeRendererInterface;
use League\CommonMark\Util\HtmlElement;
final class HintRenderer implements NodeRendererInterface
{
/**
* @param Hint $node
*
* {@inheritDoc}
*
* @psalm-suppress MoreSpecificImplementedParamType
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer): \Stringable
{
Hint::assertInstanceOf($node);
$attrs = $node->data->get('attributes');
isset($attrs['class']) ? $attrs['class'] .= ' hint' : $attrs['class'] = 'c-tip';
if ($type = $node->getType()) {
$attrs['class'] = isset($attrs['class']) ? $attrs['class'].' ' : '';
$attrs['class'] .= $type.' c-tip--'.$type;
}
if ($type === 'watch') {
return $this->renderWatch($node, $childRenderer, $attrs);
}
$title = $node->getTitle();
$title = $title
? new HtmlElement(
'span',
['class' => 'hint-title'],
$title,
)
: '';
$content = $childRenderer->renderNodes($node->children());
// Add mascot image for tips and best practices
$mascot = in_array($type, ['tip', 'hint', 'best-practice', 'warning'])
? '<img src="/img/tip-troll.webp" class="c-tip__mascot" alt="A troll pointing a teaching stick" width="242" height="293" />'
: '';
return new HtmlElement(
'div',
$attrs,
"\n".
$title."\n".
$content.
$mascot.
"\n"
);
}
private function renderWatch(Hint $node, ChildNodeRendererInterface $childRenderer, array $attrs)
{
// Strip all HTML tags except for essential formatting elements (links, code, bold, italic)
// This ensures the caption is rendered as plain text without unwanted p tags or other wrappers
$caption = strip_tags($childRenderer->renderNodes($node->children()), '<a><code><strong><em>');
return new HtmlElement(
'div',
$attrs,
'<figure class="c-video">'.
'<iframe src="'.$node->getTitle().'"></iframe>'.
'<figcaption>'.$caption.'</figcaption>'.
'</figure>'
);
}
}
================================================
FILE: app/Markdown/Hint/HintStartParser.php
================================================
<?php
namespace App\Markdown\Hint;
use League\CommonMark\Parser\Block\BlockStart;
use League\CommonMark\Parser\Block\BlockStartParserInterface;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\MarkdownParserStateInterface;
class HintStartParser implements BlockStartParserInterface
{
public function tryStart(Cursor $cursor, MarkdownParserStateInterface $parserState): ?BlockStart
{
if ($cursor->isIndented()) {
return BlockStart::none();
}
$fence = $cursor->match('/^(?:\:{3,}\s?(?!.*`))/');
if ($fence === null) {
return BlockStart::none();
}
$headerText = $cursor->getRemainder();
$cursor->advanceToEnd();
return BlockStart::of(new HintParser($headerText))->at($cursor);
}
}
================================================
FILE: app/Markdown/Tabs/TabbedCodeBlock.php
================================================
<?php
namespace App\Markdown\Tabs;
use League\CommonMark\Node\Block\AbstractBlock;
class TabbedCodeBlock extends AbstractBlock
{
// You can store code snippets for each tab here
protected $codeSamples = [];
public function addCodeSample($language, $code)
{
$this->codeSamples[$language] = $code;
}
public function getCodeSamples()
{
return $this->codeSamples;
}
}
================================================
FILE: app/Markdown/Tabs/TabbedCodeBlockExtension.php
================================================
<?php
namespace App\Markdown\Tabs;
use League\CommonMark\Environment\EnvironmentBuilderInterface;
use League\CommonMark\Extension\ExtensionInterface;
class TabbedCodeBlockExtension implements ExtensionInterface
{
public function register(EnvironmentBuilderInterface $environment): void
{
$environment->addBlockStartParser(new TabbedCodeStartParser);
$environment->addRenderer(TabbedCodeBlock::class, new TabsRenderer);
}
}
================================================
FILE: app/Markdown/Tabs/TabbedCodeStartParser.php
================================================
<?php
namespace App\Markdown\Tabs;
use League\CommonMark\Parser\Block\BlockStart;
use League\CommonMark\Parser\Block\BlockStartParserInterface;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\MarkdownParserStateInterface;
class TabbedCodeStartParser implements BlockStartParserInterface
{
public function tryStart(Cursor $cursor, MarkdownParserStateInterface $parserState): ?BlockStart
{
if ($cursor->isIndented()) {
return BlockStart::none();
}
$fence = $cursor->match('/^(?:\:{2,}tabs)/');
if ($fence === null) {
return BlockStart::none();
}
$headerText = $cursor->getRemainder();
$cursor->advanceToEnd();
return BlockStart::of(new TabsParser)->at($cursor);
}
}
================================================
FILE: app/Markdown/Tabs/TabsParser.php
================================================
<?php
namespace App\Markdown\Tabs;
use League\CommonMark\Node\Block\AbstractBlock;
use League\CommonMark\Parser\Block\AbstractBlockContinueParser;
use League\CommonMark\Parser\Block\BlockContinue;
use League\CommonMark\Parser\Block\BlockContinueParserInterface;
use League\CommonMark\Parser\Cursor;
class TabsParser extends AbstractBlockContinueParser implements BlockContinueParserInterface
{
protected TabbedCodeBlock $tabs;
public function __construct()
{
$this->tabs = new TabbedCodeBlock;
}
public function isContainer(): bool
{
return true;
}
public function canContain(AbstractBlock $childBlock): bool
{
return true;
}
public function getBlock(): AbstractBlock
{
return $this->tabs;
}
public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
{
if ($cursor->getLine() === '::') {
return BlockContinue::finished();
}
return BlockContinue::at($cursor);
}
}
================================================
FILE: app/Markdown/Tabs/TabsRenderer.php
================================================
<?php
namespace App\Markdown\Tabs;
use Illuminate\Support\Str;
use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
use League\CommonMark\Node\Block\Paragraph;
use League\CommonMark\Node\Inline\Text;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Renderer\NodeRendererInterface;
use League\CommonMark\Util\HtmlElement;
class TabsRenderer implements NodeRendererInterface
{
protected array $languageNames = [
'blade' => 'Blade',
'antlers' => 'Antlers',
'php' => 'PHP',
];
public function render(Node $node, ChildNodeRendererInterface $childRenderer)
{
TabbedCodeBlock::assertInstanceOf($node);
$attrs = $node->data->get('attributes');
$attrs['class'] = 'c-doc-tabs';
$tabs = [];
$currentTab = [];
$tabNameSetManually = false;
$lastTabName = '';
foreach ($node->children() as $child) {
if ($child instanceof FencedCode && ! $tabNameSetManually) {
$lastTabName = mb_strtoupper($child->getInfo());
}
if ($child instanceof Paragraph && $child->firstChild() instanceof Text) {
/** @var Text $text */
$text = $child->firstChild();
if (Str::startsWith($text->getLiteral(), '::tab')) {
$renderedContent = $childRenderer->renderNodes($currentTab);
$currentTab = [];
$extra = trim(mb_substr($text->getLiteral(), 5));
$currentTabName = $lastTabName;
if (mb_strlen($extra) > 0) {
$lastTabName = $extra;
$tabNameSetManually = true;
} else {
$tabNameSetManually = false;
}
if (mb_strlen(strip_tags($renderedContent)) == 0) {
continue;
}
$tabs[$currentTabName] = $renderedContent;
continue;
}
}
$currentTab[] = $child;
}
if (count($currentTab)) {
$tabs[$lastTabName] = $childRenderer->renderNodes($currentTab);
$currentTab = [];
}
$sampleNames = [];
foreach ($tabs as $language => $sample) {
if (array_key_exists($language, $this->languageNames)) {
$sampleNames[$language] = $this->languageNames[$language];
continue;
}
$sampleNames[$language] = mb_strtoupper($language);
}
return new HtmlElement(
'div',
$attrs,
view('tabs', ['tabs' => $sampleNames, 'samples' => $tabs, 'active' => array_keys($tabs)[0]])->render()
);
}
}
================================================
FILE: app/Models/User.php
================================================
<?php
namespace App\Models;
// use Illuminate\Contracts\Auth\MustVerifyEmail;
use Database\Factories\UserFactory;
use Illuminate\Database\Eloquent\Attributes\Fillable;
use Illuminate\Database\Eloquent\Attributes\Hidden;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
#[Fillable(['name', 'email', 'password'])]
#[Hidden(['password', 'remember_token'])]
class User extends Authenticatable
{
/** @use HasFactory<UserFactory> */
use HasFactory, Notifiable;
/**
* Get the attributes that should be cast.
*
* @return array<string, string>
*/
protected function casts(): array
{
return [
'email_verified_at' => 'datetime',
'password' => 'hashed',
];
}
}
================================================
FILE: app/Modifiers/Split.php
================================================
<?php
namespace App\Modifiers;
use Statamic\Modifiers\Modifier;
use Statamic\Support\Arr;
class Split extends Modifier
{
private $context;
/**
* Break an array into a given number of groups.
*
* @return array
*/
public function index($value, $params)
{
$size = Arr::get($params, 0, 1);
return collect($value)
->split($size)
->map(function ($collection) {
return [
'items' => $collection->all(),
];
})->all();
}
}
================================================
FILE: app/Modifiers/Toc.php
================================================
<?php
namespace App\Modifiers;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;
use Statamic\Modifiers\Modifier;
use Statamic\Statamic;
class Toc extends Modifier
{
private $context;
/**
* Modify a value
*
* @param mixed $value The value to be modified
* @param array $params Any parameters used in the modifier
* @param array $context Contextual values
* @return mixed
*/
public function index($value, $params, $context)
{
$this->context = $context;
$creatingIds = Arr::get($params, 0) == 'ids';
// Here maxHeadingLevels is set to either 5 (when creating IDs) or 3 (for TOC)
[$toc, $content] = $this->create($value, $creatingIds ? 5 : 3);
return $creatingIds ? $content : $toc;
}
// Good golly this thing is ugly.
private function create($content, $maxHeadingLevels)
{
// First try with h2-hN headings
preg_match_all('/<h([2-'.$maxHeadingLevels.'])([^>]*)>(.*)<\/h[2-'.$maxHeadingLevels.']>/i', $content, $matches, PREG_SET_ORDER);
// If we don't have enough entries, include h1 headings as well
if (count($matches) < 3) {
preg_match_all('/<h([1-'.$maxHeadingLevels.'])([^>]*)>(.*)<\/h[1-'.$maxHeadingLevels.']>/i', $content, $matches, PREG_SET_ORDER);
}
if (! $matches) {
return [null, $content];
}
// Track unique anchor IDs across the document
global $anchors;
$anchors = [];
// Initialize TOC with an unordered list
$toc = '<ul class="o-scroll-spy-timeline__toc js__scroll-spy-toc">'."\n";
$i = 0;
foreach ($matches as $heading) {
// Track the starting heading level for proper list nesting
if ($i == 0) {
$startlvl = ($heading[1] == '1') ? '2' : $heading[1];
}
// Normalize h1 to same level as h2
$lvl = ($heading[1] == '1') ? '2' : $heading[1];
// Get the ID attribute generated by Commonmark
$anchor = Str::of($heading[0])->after('id="')->before('"');
// Extract title from title attribute or use heading text
$ret = preg_match('/title=[\'|"](.*)?[\'|"]/i', stripslashes($heading[2]), $title);
if ($ret && $title[1] != '') {
$title = stripslashes($title[1]);
} else {
$title = $heading[3];
}
$title = trim(strip_tags($title));
// Remove the "#" suffix from titles.
$title = str($title)->replaceEnd('#', '')->__toString();
// Handle nested list structure based on heading levels
if ($i > 0) {
if ($prevlvl < $lvl) {
// Start a new nested list wrapped in li, don't increment counter for parent li
$toc .= "\n".'<li><ul>'."\n";
} elseif ($prevlvl > $lvl) {
// Close current item and any nested lists
$toc .= '</li>'."\n";
while ($prevlvl > $lvl) {
$toc .= '</ul></li>'."\n".'</li>'."\n";
$prevlvl--;
}
} else {
// Close current item at same level
$toc .= '</li>'."\n";
}
}
// Add TOC entry (only for leaf nodes)
$toc .= '<li><a href="#'.$anchor.'">'.$title.'</a>';
$prevlvl = $lvl;
$i++;
}
unset($anchors);
while ($lvl > $startlvl) {
$toc .= "\n</ul>";
$lvl--;
}
$toc .= '</li>'."\n";
$toc .= '</ul>'."\n";
return [$toc, $content];
}
/**
* Safely extracts value from Statamic Value objects
*/
private function valueGet($value)
{
if ($value instanceof \Statamic\Fields\Value) {
return $value->value();
}
return $value;
}
private function slugify($text)
{
$slugified = Statamic::modify($text)->replace('&', '')->slugify()->stripTags();
// Remove 'code-code' from the slugified text e.g. Otherwise "the `@` ignore symbol" gets converted to `the-code-code-ignore-symbol`
$slugified = str_replace('code-code-', '', $slugified);
// Remove HTML entity remnants that might be left after processing
// Only remove these if they appear as standalone words or at word boundaries
$slugified = preg_replace('/\b(codelt|rt|gtcode)\b/', '', $slugified);
return $slugified;
}
}
================================================
FILE: app/Providers/AppServiceProvider.php
================================================
<?php
namespace App\Providers;
use App\Markdown\Hint\HintExtension;
use App\Markdown\Tabs\TabbedCodeBlockExtension;
use App\Search\Listeners\SearchEntriesCreatedListener;
use App\Search\Storybook\StorybookSearchProvider;
use Illuminate\Support\Facades\Event;
use Illuminate\Support\ServiceProvider;
use League\CommonMark\Extension\Attributes\AttributesExtension;
use League\CommonMark\Extension\DescriptionList\DescriptionListExtension;
use League\CommonMark\Extension\HeadingPermalink\HeadingPermalinkExtension;
use Statamic\Facades\Markdown;
use Stillat\DocumentationSearch\Events\SearchEntriesCreated;
use Torchlight\Engine\CommonMark\Extension as TorchlightExtension;
use Torchlight\Engine\Options as TorchlightOptions;
class AppServiceProvider extends ServiceProvider
{
/**
* Register any application services.
*/
public function register(): void
{
//
}
/**
* Bootstrap any application services.
*/
public function boot(): void
{
Markdown::addExtensions(function () {
return [new DescriptionListExtension, new HintExtension, new TabbedCodeBlockExtension, new AttributesExtension, new HeadingPermalinkExtension];
});
if (! app()->runningConsoleCommand('search:update')) {
TorchlightOptions::setDefaultOptionsBuilder(fn () => TorchlightOptions::fromArray(config('torchlight.options')));
$extension = new TorchlightExtension(config('torchlight.theme'));
$extension
->renderer()
->setDefaultGrammar(config('torchlight.options.defaultLanguage'));
Markdown::addExtension(fn () => $extension);
}
Event::listen(SearchEntriesCreated::class, SearchEntriesCreatedListener::class);
StorybookSearchProvider::register();
}
}
================================================
FILE: app/Search/DocTransformer.php
================================================
<?php
namespace App\Search;
use Illuminate\Support\Str;
use Stillat\DocumentationSearch\Contracts\DocumentTransformer;
use Stillat\DocumentationSearch\Document\DocumentFragment;
class DocTransformer implements DocumentTransformer
{
private function normalizeConent($value)
{
return str($value)
->lower()
->explode(' ')
->map(fn ($word) => Str::singular($word))
->join(' ');
}
public function handle(DocumentFragment $fragment, $entry): void
{
$fragment->additionalContextData[] = $this->normalizeConent($entry->title);
// Add some extra details to "additional_context"
if (Str::containsAll($fragment->content, ['clear', 'cache'])) {
$fragment->additionalContextData[] = 'delete cache';
}
if (Str::contains($fragment->content, 'JS Drivers')) {
$fragment->additionalContextData[] = 'javascript drivers';
}
}
}
================================================
FILE: app/Search/Listeners/SearchEntriesCreatedListener.php
================================================
<?php
namespace App\Search\Listeners;
use Stillat\DocumentationSearch\Events\SearchEntriesCreated;
class SearchEntriesCreatedListener
{
protected array $escapeProperties = [
'description',
'intro',
'content',
'search_content',
];
protected function getParentHeadings($headers, $target)
{
$hierarchy = [];
$levels = [];
$currentLevel = $target->level;
for ($i = array_search($target, $headers) - 1; $i >= 0; $i--) {
$header = $headers[$i];
if ($header->level < $currentLevel) {
$hierarchy[] = $header;
$currentLevel = $header->level;
}
}
foreach (array_reverse($hierarchy) as $level) {
$levels[$level->level] = str($level->text)->replaceEnd('#', '')->__toString();
}
return $levels;
}
/**
* Handle the event.
*/
public function handle(SearchEntriesCreated $event): void
{
$collection = $event->entry->collection()->title;
$headers = [];
foreach ($event->sections as $section) {
if ($section->fragment->headerDetails == null) {
continue;
}
$headers[] = $section->fragment->headerDetails;
}
foreach ($event->sections as $section) {
$data = $section->searchEntry->data();
$data['search_title'] = str($data['search_title'] ?? '')->replaceEnd('#', '')->__toString();
$category = match (true) {
$collection === 'Pages' => ($event->entry->parent() ? $event->entry->parent()?->title.' » ' : null).$data['origin_title'],
default => $collection.' » '.$data['origin_title'],
};
$parentHeadings = null;
if (
$section->fragment->headerDetails != null &&
$section->fragment->headerDetails->level >= 3
) {
$header = $section->fragment->headerDetails;
$parentHeadings = $this->getParentHeadings(
$headers,
$header
);
$parentHeadings[$header->level] = $header->text;
}
if ($parentHeadings === null) {
$parentHeadings = [];
if ($data['search_title'] != null && $data['origin_title'] != $data['search_title']) {
$parentHeadings[1] = $data['search_title'];
}
}
if (count($parentHeadings) > 2) {
array_shift($parentHeadings);
}
$data['hierarchy_lvl0'] = $category;
$data['hierarchy_lvl1'] = str(implode(' » ', $parentHeadings))->replaceEnd('#', '')->__toString();
if ($data['is_root']) {
$data['content'] = strip_tags($event->entry->intro ?? $event->entry->description ?? $data['search_content']);
} else {
$data['content'] = $data['search_content'] ?? '';
}
$data['url'] = $data['search_url'];
foreach ($this->escapeProperties as $property) {
if (! $data->has($property)) {
continue;
}
$data[$property] = e($data[$property]);
}
// Clear this out to prevent "too much" from a specific page dominating the results.
if (! $data['is_root']) {
$data['origin_title'] = null;
}
$section->searchEntry->data($data);
}
}
}
================================================
FILE: app/Search/RequestContentRetriever.php
================================================
<?php
namespace App\Search;
use DOMDocument;
use Illuminate\Http\Request;
use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Cascade;
use Stillat\DocumentationSearch\Contracts\ContentRetriever;
class RequestContentRetriever implements ContentRetriever
{
public function getContent(Entry $entry): string
{
$originalRequest = app('request');
$request = tap(Request::capture(), function ($request) {
app()->instance('request', $request);
Cascade::withRequest($request);
});
$content = '';
try {
$content = $entry->toResponse($request)->getContent();
} finally {
app()->instance('request', $originalRequest);
}
return $this->extractArticleContent($content);
}
protected function extractArticleContent(string $content): string
{
$dom = new DOMDocument;
libxml_use_internal_errors(true);
$dom->loadHTML($content);
libxml_clear_errors();
$articles = $dom->getElementsByTagName('article');
$result = '';
foreach ($articles as $article) {
$result .= $dom->saveHTML($article);
}
return $result;
}
}
================================================
FILE: app/Search/Storybook/StorybookSearchProvider.php
================================================
<?php
namespace App\Search\Storybook;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\LazyCollection;
use Illuminate\Support\Str;
use Statamic\Search\Searchables\Provider;
class StorybookSearchProvider extends Provider
{
protected static $handle = 'storybook';
protected static $referencePrefix = 'storybook';
public function provide(): Collection|LazyCollection
{
return Http::get('https://ui.statamic.dev/index.json')
->collect('entries')
->filter(fn (array $story) => Str::endsWith($story['id'], ['--docs', '--default']))
->unique('title')
->map(fn (array $story) => StorybookSearchable::from($story))
->map->reference();
}
public function contains($searchable): bool
{
// TODO: Implement contains() method.
}
public function find(array $keys): Collection
{
$stories = Http::get('https://ui.statamic.dev/index.json')->collect('entries');
return collect($keys)->map(fn (string $key) => StorybookSearchable::from($stories->get($key)));
}
}
================================================
FILE: app/Search/Storybook/StorybookSearchable.php
================================================
<?php
namespace App\Search\Storybook;
use Illuminate\Support\Str;
use Statamic\Contracts\Search\Searchable as SearchableContract;
use Statamic\Search\Searchable;
class StorybookSearchable implements SearchableContract
{
use Searchable;
protected string $id;
protected string $title;
public static function from(array $component)
{
$instance = new static();
$instance->id = $component['id'];
$instance->title = Str::after($component['title'], '/');
return $instance;
}
public function id(): string
{
return $this->id;
}
public function title(): string
{
return $this->title;
}
public function getSearchValue(string $field)
{
if ($field === 'title' || $field === 'origin_title' || $field === 'search_title') {
return $this->title();
}
if ($field === 'hierarchy_lvl0') {
return "UI Components » {$this->title()}";
}
if ($field === 'url') {
return $this->url();
}
return null;
}
public function url(): string
{
return "https://ui.statamic.dev/?path=/docs/{$this->id}";
}
public function reference(): string
{
return "storybook::{$this->id()}";
}
}
================================================
FILE: app/Tags/GithubCommitsUrl.php
================================================
<?php
namespace App\Tags;
use Illuminate\Support\Str;
use Statamic\Facades\Data;
class GithubCommitsUrl extends \Statamic\Tags\Tags
{
public function index()
{
if (! $id = $this->context->get('id')) {
return false;
}
$content = Data::find($id);
if ($content instanceof \Statamic\Taxonomies\LocalizedTerm) {
return;
}
$path = Str::after($content->path(), 'content/');
return "https://github.com/statamic/docs/commits/{$this->getCurrentBranch()}/content/{$path}";
}
private function getCurrentBranch(): string
{
return collect(config('docs.versions'))
->where('version', config('docs.version'))
->first()['branch'] ?? '5.x';
}
}
================================================
FILE: app/Tags/GithubEditUrl.php
================================================
<?php
namespace App\Tags;
use Illuminate\Support\Str;
use Statamic\Facades\Data;
class GithubEditUrl extends \Statamic\Tags\Tags
{
public function index()
{
if (! $id = $this->context->get('id')) {
return false;
}
$content = Data::find($id);
if ($content instanceof \Statamic\Taxonomies\LocalizedTerm) {
return;
}
$path = Str::after($path = $content->path(), 'content/');
return "https://github.com/statamic/docs/blob/{$this->getCurrentBranch()}/content/{$path}";
}
private function getCurrentBranch(): string
{
return collect(config('docs.versions'))
->where('version', config('docs.version'))
->first()['branch'] ?? '5.x';
}
}
================================================
FILE: app/Tags/HeroSponsors.php
================================================
<?php
namespace App\Tags;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Http;
use Illuminate\Support\Facades\Log;
use Illuminate\Support\LazyCollection;
use Statamic\Support\Arr;
use Statamic\Tags\Tags;
class HeroSponsors extends Tags
{
public function index()
{
return Cache::remember('hero-sponsors', now()->addHour(), function () {
try {
return $this->sponsors()->collect()->where('price', '>=', 25);
} catch (\Exception $e) {
Log::error($e);
return collect(['error' => true]);
}
});
}
private function sponsors()
{
return LazyCollection::make(function () {
$cursor = null;
do {
$data = $this->request($cursor);
$sponsorships = Arr::get($data, 'data.viewer.organization.sponsorshipsAsMaintainer');
$cursor = $sponsorships['pageInfo']['endCursor'];
$hasNextPage = $sponsorships['pageInfo']['hasNextPage'];
yield from collect($sponsorships['nodes'])->map(fn ($sponsorship) => array_merge(
$sponsorship['sponsorEntity'],
['price' => $sponsorship['tier']['monthlyPriceInDollars']]
));
} while ($hasNextPage && $cursor);
});
}
private function request($cursor)
{
return Http::baseUrl('https://api.github.com')
->withToken(config('services.github.token'))
->asJson()
->accept('application/vnd.github.v4+json')
->withUserAgent('statamic/docs')
->post('/graphql', [
'query' => $this->query(),
'variables' => ['cursor' => $cursor],
])
->json();
}
private function query()
{
return <<<'GQL'
query($cursor: String) {
viewer {
organization(login: "statamic") {
sponsorshipsAsMaintainer(first: 100, after: $cursor, orderBy: {direction: ASC, field: CREATED_AT}) {
pageInfo {
hasNextPage
endCursor
}
nodes {
sponsorEntity {
... on User {
name
url
avatarUrl(size: 80)
}
... on Organization {
name
url
avatarUrl(size: 80)
}
}
tier {
name
monthlyPriceInDollars
}
}
}
}
}
}
GQL;
}
}
================================================
FILE: app/ViewModels/Fieldtypes.php
================================================
<?php
namespace App\ViewModels;
use Statamic\View\ViewModel;
class Fieldtypes extends ViewModel
{
public function data(): array
{
return ['title' => ucwords($this->cascade->get('title')).' Fieldtype'];
}
}
================================================
FILE: app/ViewModels/Modifiers.php
================================================
<?php
namespace App\ViewModels;
use Statamic\View\ViewModel;
class Modifiers extends ViewModel
{
public function data(): array
{
return ['title' => ucwords($this->cascade->get('title')).' Modifier'];
}
}
================================================
FILE: app/ViewModels/Tags.php
================================================
<?php
namespace App\ViewModels;
use Statamic\View\ViewModel;
class Tags extends ViewModel
{
public function data(): array
{
return ['title' => ucwords($this->cascade->get('slug')).' Tag'];
}
}
================================================
FILE: app/ViewModels/Variables.php
================================================
<?php
namespace App\ViewModels;
use Statamic\View\ViewModel;
class Variables extends ViewModel
{
public function data(): array
{
return ['title' => strtolower($this->cascade->get('slug'))];
}
}
================================================
FILE: artisan
================================================
#!/usr/bin/env php
<?php
use Symfony\Component\Console\Input\ArgvInput;
define('LARAVEL_START', microtime(true));
// Register the Composer autoloader...
require __DIR__.'/vendor/autoload.php';
// Bootstrap Laravel and handle the command...
$status = (require_once __DIR__.'/bootstrap/app.php')
->handleCommand(new ArgvInput);
exit($status);
================================================
FILE: bootstrap/app.php
================================================
<?php
use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
return Application::configure(basePath: dirname(__DIR__))
->withRouting(
web: __DIR__.'/../routes/web.php',
commands: __DIR__.'/../routes/console.php',
health: '/up',
)
->withMiddleware(function (Middleware $middleware): void {
//
})
->withExceptions(function (Exceptions $exceptions): void {
//
})->create();
================================================
FILE: bootstrap/cache/.gitignore
================================================
*
!.gitignore
================================================
FILE: bootstrap/providers.php
================================================
<?php
use App\Providers\AppServiceProvider;
return [
AppServiceProvider::class,
];
================================================
FILE: composer.json
================================================
{
"name": "laravel/laravel",
"type": "project",
"description": "The Laravel Framework.",
"keywords": [
"framework",
"laravel"
],
"license": "MIT",
"require": {
"php": "^8.2",
"laravel/framework": "^13.0",
"laravel/tinker": "^3.0",
"statamic-rad-pack/meilisearch": "^4.1",
"statamic/cms": "^6.0",
"torchlight/engine": "^0.1.0",
"stillat/documentation-search": "^2.0"
},
"require-dev": {
"fruitcake/laravel-debugbar": "^4.0",
"fakerphp/faker": "^1.4",
"mockery/mockery": "^1.0",
"nunomaduro/collision": "^8.0",
"phpunit/phpunit": "^12.0",
"spatie/laravel-ignition": "^2.0",
"spatie/laravel-ray": "^1.37"
},
"config": {
"optimize-autoloader": true,
"preferred-install": "dist",
"sort-packages": true,
"allow-plugins": {
"composer/package-versions-deprecated": true,
"pixelfear/composer-dist-plugin": true,
"php-http/discovery": true
}
},
"extra": {
"laravel": {
"dont-discover": []
}
},
"autoload": {
"psr-4": {
"App\\": "app/",
"Database\\Factories\\": "database/factories/",
"Database\\Seeders\\": "database/seeders/"
}
},
"autoload-dev": {
"psr-4": {
"Tests\\": "tests/"
}
},
"prefer-stable": true,
"minimum-stability": "dev",
"scripts": {
"pre-update-cmd": [
"Statamic\\Console\\Composer\\Scripts::preUpdateCmd"
],
"post-autoload-dump": [
"Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
"@php artisan package:discover --ansi",
"@php artisan statamic:install --ansi"
],
"post-root-package-install": [
"@php -r \"file_exists('.env') || copy('.env.example', '.env');\""
],
"post-create-project-cmd": [
"@php artisan key:generate --ansi"
]
}
}
================================================
FILE: config/app.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Application Name
|--------------------------------------------------------------------------
|
| This value is the name of your application, which will be used when the
| framework needs to place the application's name in a notification or
| other UI elements where an application name needs to be displayed.
|
*/
'name' => env('APP_NAME', 'Statamic'),
/*
|--------------------------------------------------------------------------
| Application Environment
|--------------------------------------------------------------------------
|
| This value determines the "environment" your application is currently
| running in. This may determine how you prefer to configure various
| services the application utilizes. Set this in your ".env" file.
|
*/
'env' => env('APP_ENV', 'production'),
/*
|--------------------------------------------------------------------------
| Application Debug Mode
|--------------------------------------------------------------------------
|
| When your application is in debug mode, detailed error messages with
| stack traces will be shown on every error that occurs within your
| application. If disabled, a simple generic error page is shown.
|
*/
'debug' => (bool) env('APP_DEBUG', false),
/*
|--------------------------------------------------------------------------
| Application URL
|--------------------------------------------------------------------------
|
| This URL is used by the console to properly generate URLs when using
| the Artisan command line tool. You should set this to the root of
| the application so that it's available within Artisan commands.
|
*/
'url' => env('APP_URL', 'http://localhost'),
/*
|--------------------------------------------------------------------------
| Application Timezone
|--------------------------------------------------------------------------
|
| Here you may specify the default timezone for your application, which
| will be used by the PHP date and date-time functions. The timezone
| is set to "UTC" by default as it is suitable for most use cases.
|
*/
'timezone' => 'UTC',
/*
|--------------------------------------------------------------------------
| Application Locale Configuration
|--------------------------------------------------------------------------
|
| The application locale determines the default locale that will be used
| by Laravel's translation / localization methods. This option can be
| set to any locale for which you plan to have translation strings.
|
*/
'locale' => env('APP_LOCALE', 'en'),
'fallback_locale' => env('APP_FALLBACK_LOCALE', 'en'),
'faker_locale' => env('APP_FAKER_LOCALE', 'en_US'),
/*
|--------------------------------------------------------------------------
| Encryption Key
|--------------------------------------------------------------------------
|
| This key is utilized by Laravel's encryption services and should be set
| to a random, 32 character string to ensure that all encrypted values
| are secure. You should do this prior to deploying the application.
|
*/
'cipher' => 'AES-256-CBC',
'key' => env('APP_KEY'),
'previous_keys' => [
...array_filter(
explode(',', (string) env('APP_PREVIOUS_KEYS', ''))
),
],
/*
|--------------------------------------------------------------------------
| Maintenance Mode Driver
|--------------------------------------------------------------------------
|
| These configuration options determine the driver used to determine and
| manage Laravel's "maintenance mode" status. The "cache" driver will
| allow maintenance mode to be controlled across multiple machines.
|
| Supported drivers: "file", "cache"
|
*/
'maintenance' => [
'driver' => env('APP_MAINTENANCE_DRIVER', 'file'),
'store' => env('APP_MAINTENANCE_STORE', 'file'),
],
];
================================================
FILE: config/auth.php
================================================
<?php
use App\Models\User;
return [
/*
|--------------------------------------------------------------------------
| Authentication Defaults
|--------------------------------------------------------------------------
|
| This option defines the default authentication "guard" and password
| reset "broker" for your application. You may change these values
| as required, but they're a perfect start for most applications.
|
*/
'defaults' => [
'guard' => env('AUTH_GUARD', 'web'),
'passwords' => env('AUTH_PASSWORD_BROKER', 'users'),
],
/*
|--------------------------------------------------------------------------
| Authentication Guards
|--------------------------------------------------------------------------
|
| Next, you may define every authentication guard for your application.
| Of course, a great default configuration has been defined for you
| which utilizes session storage plus the Eloquent user provider.
|
| All authentication guards have a user provider, which defines how the
| users are actually retrieved out of your database or other storage
| system used by the application. Typically, Eloquent is utilized.
|
| Supported: "session"
|
*/
'guards' => [
'web' => [
'driver' => 'session',
'provider' => 'users',
],
],
/*
|--------------------------------------------------------------------------
| User Providers
|--------------------------------------------------------------------------
|
| All authentication guards have a user provider, which defines how the
| users are actually retrieved out of your database or other storage
| system used by the application. Typically, Eloquent is utilized.
|
| If you have multiple user tables or models you may configure multiple
| providers to represent the model / table. These providers may then
| be assigned to any extra authentication guards you have defined.
|
| Supported: "statamic", "database", "eloquent"
|
*/
'providers' => [
'users' => [
'driver' => 'statamic',
],
// 'users' => [
// 'driver' => 'eloquent',
// 'model' => env('AUTH_MODEL', User::class),
// ],
// 'users' => [
// 'driver' => 'database',
// 'table' => 'users',
// ],
],
/*
|--------------------------------------------------------------------------
| Resetting Passwords
|--------------------------------------------------------------------------
|
| These configuration options specify the behavior of Laravel's password
| reset functionality, including the table utilized for token storage
| and the user provider that is invoked to actually retrieve users.
|
| The expiry time is the number of minutes that each reset token will be
| considered valid. This security feature keeps tokens short-lived so
| they have less time to be guessed. You may change this as needed.
|
| The throttle setting is the number of seconds a user must wait before
| generating more password reset tokens. This prevents the user from
| quickly generating a very large amount of password reset tokens.
|
*/
'passwords' => [
'users' => [
'provider' => 'users',
'table' => env('AUTH_PASSWORD_RESET_TOKEN_TABLE', 'password_reset_tokens'),
'expire' => 60,
'throttle' => 60,
],
'activations' => [
'provider' => 'users',
'table' => env('AUTH_ACTIVATION_TOKEN_TABLE', 'password_activation_tokens'),
'expire' => 4320,
'throttle' => 60,
],
],
/*
|--------------------------------------------------------------------------
| Password Confirmation Timeout
|--------------------------------------------------------------------------
|
| Here you may define the number of seconds before a password confirmation
| window expires and users are asked to re-enter their password via the
| confirmation screen. By default, the timeout lasts for three hours.
|
*/
'password_timeout' => env('AUTH_PASSWORD_TIMEOUT', 10800),
];
================================================
FILE: config/cache.php
================================================
<?php
use Illuminate\Support\Str;
return [
/*
|--------------------------------------------------------------------------
| Default Cache Store
|--------------------------------------------------------------------------
|
| This option controls the default cache store that will be used by the
| framework. This connection is utilized if another isn't explicitly
| specified when running a cache operation inside the application.
|
*/
'default' => env('CACHE_STORE', 'file'),
/*
|--------------------------------------------------------------------------
| Cache Stores
|--------------------------------------------------------------------------
|
| Here you may define all of the cache "stores" for your application as
| well as their drivers. You may even define multiple stores for the
| same cache driver to group types of items stored in your caches.
|
| Supported drivers: "array", "database", "file", "memcached",
| "redis", "dynamodb", "octane",
| "failover", "null"
|
*/
'stores' => [
'array' => [
'driver' => 'array',
'serialize' => false,
],
'database' => [
'driver' => 'database',
'connection' => env('DB_CACHE_CONNECTION', null),
'table' => env('DB_CACHE_TABLE', 'cache'),
'lock_connection' => env('DB_CACHE_LOCK_CONNECTION'),
'lock_table' => env('DB_CACHE_LOCK_TABLE'),
],
'file' => [
'driver' => 'file',
'path' => storage_path('framework/cache/data'),
'lock_path' => storage_path('framework/cache/data'),
],
'memcached' => [
'driver' => 'memcached',
'persistent_id' => env('MEMCACHED_PERSISTENT_ID'),
'sasl' => [
env('MEMCACHED_USERNAME'),
env('MEMCACHED_PASSWORD'),
],
'options' => [
// Memcached::OPT_CONNECT_TIMEOUT => 2000,
],
'servers' => [
[
'host' => env('MEMCACHED_HOST', '127.0.0.1'),
'port' => env('MEMCACHED_PORT', 11211),
'weight' => 100,
],
],
],
'redis' => [
'driver' => 'redis',
'connection' => env('REDIS_CACHE_CONNECTION', 'cache'),
'lock_connection' => env('REDIS_CACHE_LOCK_CONNECTION', 'default'),
],
'dynamodb' => [
'driver' => 'dynamodb',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
'table' => env('DYNAMODB_CACHE_TABLE', 'cache'),
'endpoint' => env('DYNAMODB_ENDPOINT'),
],
'octane' => [
'driver' => 'octane',
],
'failover' => [
'driver' => 'failover',
'stores' => [
'database',
'array',
],
],
'static_cache' => [
'driver' => 'file',
'path' => storage_path('statamic/static-urls-cache'),
],
],
/*
|--------------------------------------------------------------------------
| Cache Key Prefix
|--------------------------------------------------------------------------
|
| When utilizing the APC, database, memcached, Redis, and DynamoDB cache
| stores, there might be other applications using the same cache. For
| that reason, you may prefix every cache key to avoid collisions.
|
*/
'prefix' => env('CACHE_PREFIX', Str::slug((string) env('APP_NAME', 'laravel')).'-cache-'),
/*
|--------------------------------------------------------------------------
| Serializable Classes
|--------------------------------------------------------------------------
|
| This value determines the classes that can be unserialized from cache
| storage. By default, no PHP classes will be unserialized from your
| cache to prevent gadget chain attacks if your APP_KEY is leaked.
|
*/
'serializable_classes' => false,
];
================================================
FILE: config/database.php
================================================
<?php
use Illuminate\Support\Str;
use Pdo\Mysql;
return [
/*
|--------------------------------------------------------------------------
| Default Database Connection Name
|--------------------------------------------------------------------------
|
| Here you may specify which of the database connections below you wish
| to use as your default connection for database operations. This is
| the connection which will be utilized unless another connection
| is explicitly specified when you execute a query / statement.
|
*/
'default' => env('DB_CONNECTION', 'sqlite'),
/*
|--------------------------------------------------------------------------
| Database Connections
|--------------------------------------------------------------------------
|
| Below are all of the database connections defined for your application.
| An example configuration is provided for each database system which
| is supported by Laravel. You're free to add / remove connections.
|
*/
'connections' => [
'sqlite' => [
'driver' => 'sqlite',
'url' => env('DB_URL'),
'database' => env('DB_DATABASE', database_path('database.sqlite')),
'prefix' => '',
'foreign_key_constraints' => env('DB_FOREIGN_KEYS', true),
'busy_timeout' => null,
'journal_mode' => null,
'synchronous' => null,
'transaction_mode' => 'DEFERRED',
],
'mysql' => [
'driver' => 'mysql',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'unix_socket' => env('DB_SOCKET', ''),
'charset' => env('DB_CHARSET', 'utf8mb4'),
'collation' => env('DB_COLLATION', 'utf8mb4_unicode_ci'),
'prefix' => '',
'prefix_indexes' => true,
'strict' => true,
'engine' => null,
'options' => extension_loaded('pdo_mysql') ? array_filter([
(PHP_VERSION_ID >= 80500 ? Mysql::ATTR_SSL_CA : PDO::MYSQL_ATTR_SSL_CA) => env('MYSQL_ATTR_SSL_CA'),
]) : [],
],
'mariadb' => [
'driver' => 'mariadb',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'unix_socket' => env('DB_SOCKET', ''),
'charset' => env('DB_CHARSET', 'utf8mb4'),
'collation' => env('DB_COLLATION', 'utf8mb4_unicode_ci'),
'prefix' => '',
'prefix_indexes' => true,
'strict' => true,
'engine' => null,
'options' => extension_loaded('pdo_mysql') ? array_filter([
(PHP_VERSION_ID >= 80500 ? Mysql::ATTR_SSL_CA : PDO::MYSQL_ATTR_SSL_CA) => env('MYSQL_ATTR_SSL_CA'),
]) : [],
],
'pgsql' => [
'driver' => 'pgsql',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '5432'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'charset' => env('DB_CHARSET', 'utf8'),
'prefix' => '',
'prefix_indexes' => true,
'search_path' => 'public',
'sslmode' => env('DB_SSLMODE', 'prefer'),
],
'sqlsrv' => [
'driver' => 'sqlsrv',
'url' => env('DB_URL'),
'host' => env('DB_HOST', 'localhost'),
'port' => env('DB_PORT', '1433'),
'database' => env('DB_DATABASE', 'laravel'),
'username' => env('DB_USERNAME', 'root'),
'password' => env('DB_PASSWORD', ''),
'charset' => env('DB_CHARSET', 'utf8'),
'prefix' => '',
'prefix_indexes' => true,
// 'encrypt' => env('DB_ENCRYPT', 'yes'),
// 'trust_server_certificate' => env('DB_TRUST_SERVER_CERTIFICATE', 'false'),
],
],
/*
|--------------------------------------------------------------------------
| Migration Repository Table
|--------------------------------------------------------------------------
|
| This table keeps track of all the migrations that have already run for
| your application. Using this information, we can determine which of
| the migrations on disk haven't actually been run on the database.
|
*/
'migrations' => [
'table' => 'migrations',
'update_date_on_publish' => true,
],
/*
|--------------------------------------------------------------------------
| Redis Databases
|--------------------------------------------------------------------------
|
| Redis is an open source, fast, and advanced key-value store that also
| provides a richer body of commands than a typical key-value system
| such as Memcached. You may define your connection settings here.
|
*/
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'prefix' => env('REDIS_PREFIX', Str::slug((string) env('APP_NAME', 'laravel')).'-database-'),
'persistent' => env('REDIS_PERSISTENT', false),
],
'default' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
'max_retries' => env('REDIS_MAX_RETRIES', 3),
'backoff_algorithm' => env('REDIS_BACKOFF_ALGORITHM', 'decorrelated_jitter'),
'backoff_base' => env('REDIS_BACKOFF_BASE', 100),
'backoff_cap' => env('REDIS_BACKOFF_CAP', 1000),
],
'cache' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_CACHE_DB', '1'),
'max_retries' => env('REDIS_MAX_RETRIES', 3),
'backoff_algorithm' => env('REDIS_BACKOFF_ALGORITHM', 'decorrelated_jitter'),
'backoff_base' => env('REDIS_BACKOFF_BASE', 100),
'backoff_cap' => env('REDIS_BACKOFF_CAP', 1000),
],
],
];
================================================
FILE: config/docs.php
================================================
<?php
return [
'version' => env('STATAMIC_DOCS_VERSION', '6'),
'versions' => [
[
'version' => '6',
'branch' => '6.x',
'url' => 'https://statamic.dev',
],
[
'version' => '5',
'branch' => '5.x',
'url' => 'https://v5.statamic.dev',
],
],
];
================================================
FILE: config/filesystems.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Filesystem Disk
|--------------------------------------------------------------------------
|
| Here you may specify the default filesystem disk that should be used
| by the framework. The "local" disk, as well as a variety of cloud
| based disks are available to your application for file storage.
|
*/
'default' => env('FILESYSTEM_DISK', 'local'),
/*
|--------------------------------------------------------------------------
| Filesystem Disks
|--------------------------------------------------------------------------
|
| Below you may configure as many filesystem disks as necessary, and you
| may even configure multiple disks for the same driver. Examples for
| most supported storage drivers are configured here for reference.
|
| Supported drivers: "local", "ftp", "sftp", "s3"
|
*/
'disks' => [
'local' => [
'driver' => 'local',
'root' => storage_path('app/private'),
'serve' => true,
'throw' => false,
'report' => false,
],
'public' => [
'driver' => 'local',
'root' => storage_path('app/public'),
'url' => rtrim(env('APP_URL', 'http://localhost'), '/').'/storage',
'visibility' => 'public',
'throw' => false,
'report' => false,
],
's3' => [
'driver' => 's3',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION'),
'bucket' => env('AWS_BUCKET'),
'url' => env('AWS_URL'),
'endpoint' => env('AWS_ENDPOINT'),
'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
'throw' => false,
'report' => false,
// 'visibility' => 'public', // https://statamic.dev/assets#container-visibility
],
'assets' => [
'driver' => 'local',
'root' => public_path('img'),
'url' => '/img',
'visibility' => 'public',
'throw' => false,
'report' => false,
],
],
/*
|--------------------------------------------------------------------------
| Symbolic Links
|--------------------------------------------------------------------------
|
| Here you may configure the symbolic links that will be created when the
| `storage:link` Artisan command is executed. The array keys should be
| the locations of the links and the values should be their targets.
|
*/
'links' => [
public_path('storage') => storage_path('app/public'),
],
];
================================================
FILE: config/logging.php
================================================
<?php
use Monolog\Handler\NullHandler;
use Monolog\Handler\StreamHandler;
use Monolog\Handler\SyslogUdpHandler;
use Monolog\Processor\PsrLogMessageProcessor;
return [
/*
|--------------------------------------------------------------------------
| Default Log Channel
|--------------------------------------------------------------------------
|
| This option defines the default log channel that is utilized to write
| messages to your logs. The value provided here should match one of
| the channels present in the list of "channels" configured below.
|
*/
'default' => env('LOG_CHANNEL', 'stack'),
/*
|--------------------------------------------------------------------------
| Deprecations Log Channel
|--------------------------------------------------------------------------
|
| This option controls the log channel that should be used to log warnings
| regarding deprecated PHP and library features. This allows you to get
| your application ready for upcoming major versions of dependencies.
|
*/
'deprecations' => [
'channel' => env('LOG_DEPRECATIONS_CHANNEL', 'null'),
'trace' => env('LOG_DEPRECATIONS_TRACE', false),
],
/*
|--------------------------------------------------------------------------
| Log Channels
|--------------------------------------------------------------------------
|
| Here you may configure the log channels for your application. Laravel
| utilizes the Monolog PHP logging library, which includes a variety
| of powerful log handlers and formatters that you're free to use.
|
| Available drivers: "single", "daily", "slack", "syslog",
| "errorlog", "monolog", "custom", "stack"
|
*/
'channels' => [
'stack' => [
'driver' => 'stack',
'channels' => explode(',', (string) env('LOG_STACK', 'single')),
'ignore_exceptions' => false,
],
'single' => [
'driver' => 'single',
'path' => storage_path('logs/laravel.log'),
'level' => env('LOG_LEVEL', 'debug'),
'replace_placeholders' => true,
],
'daily' => [
'driver' => 'daily',
'path' => storage_path('logs/laravel.log'),
'level' => env('LOG_LEVEL', 'debug'),
'days' => env('LOG_DAILY_DAYS', 14),
'replace_placeholders' => true,
],
'slack' => [
'driver' => 'slack',
'url' => env('LOG_SLACK_WEBHOOK_URL'),
'username' => env('LOG_SLACK_USERNAME', env('APP_NAME', 'Laravel')),
'emoji' => env('LOG_SLACK_EMOJI', ':boom:'),
'level' => env('LOG_LEVEL', 'critical'),
'replace_placeholders' => true,
],
'papertrail' => [
'driver' => 'monolog',
'level' => env('LOG_LEVEL', 'debug'),
'handler' => env('LOG_PAPERTRAIL_HANDLER', SyslogUdpHandler::class),
'handler_with' => [
'host' => env('PAPERTRAIL_URL'),
'port' => env('PAPERTRAIL_PORT'),
'connectionString' => 'tls://'.env('PAPERTRAIL_URL').':'.env('PAPERTRAIL_PORT'),
],
'processors' => [PsrLogMessageProcessor::class],
],
'stderr' => [
'driver' => 'monolog',
'level' => env('LOG_LEVEL', 'debug'),
'handler' => StreamHandler::class,
'handler_with' => [
'stream' => 'php://stderr',
],
'formatter' => env('LOG_STDERR_FORMATTER'),
'processors' => [PsrLogMessageProcessor::class],
],
'syslog' => [
'driver' => 'syslog',
'level' => env('LOG_LEVEL', 'debug'),
'facility' => env('LOG_SYSLOG_FACILITY', LOG_USER),
'replace_placeholders' => true,
],
'errorlog' => [
'driver' => 'errorlog',
'level' => env('LOG_LEVEL', 'debug'),
'replace_placeholders' => true,
],
'null' => [
'driver' => 'monolog',
'handler' => NullHandler::class,
],
'emergency' => [
'path' => storage_path('logs/laravel.log'),
],
],
];
================================================
FILE: config/mail.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Mailer
|--------------------------------------------------------------------------
|
| This option controls the default mailer that is used to send all email
| messages unless another mailer is explicitly specified when sending
| the message. All additional mailers can be configured within the
| "mailers" array. Examples of each type of mailer are provided.
|
*/
'default' => env('MAIL_MAILER', 'log'),
/*
|--------------------------------------------------------------------------
| Mailer Configurations
|--------------------------------------------------------------------------
|
| Here you may configure all of the mailers used by your application plus
| their respective settings. Several examples have been configured for
| you and you are free to add your own as your application requires.
|
| Laravel supports a variety of mail "transport" drivers that can be used
| when delivering an email. You may specify which one you're using for
| your mailers below. You may also add additional mailers if needed.
|
| Supported: "smtp", "sendmail", "mailgun", "ses", "ses-v2",
| "postmark", "resend", "log", "array",
| "failover", "roundrobin"
|
*/
'mailers' => [
'smtp' => [
'transport' => 'smtp',
'scheme' => env('MAIL_SCHEME'),
'url' => env('MAIL_URL'),
'host' => env('MAIL_HOST', '127.0.0.1'),
'port' => env('MAIL_PORT', 2525),
'username' => env('MAIL_USERNAME'),
'password' => env('MAIL_PASSWORD'),
'timeout' => null,
'local_domain' => env('MAIL_EHLO_DOMAIN', parse_url((string) env('APP_URL', 'http://localhost'), PHP_URL_HOST)),
],
'ses' => [
'transport' => 'ses',
],
'postmark' => [
'transport' => 'postmark',
// 'message_stream_id' => env('POSTMARK_MESSAGE_STREAM_ID'),
// 'client' => [
// 'timeout' => 5,
// ],
],
'resend' => [
'transport' => 'resend',
],
'sendmail' => [
'transport' => 'sendmail',
'path' => env('MAIL_SENDMAIL_PATH', '/usr/sbin/sendmail -bs -i'),
],
'log' => [
'transport' => 'log',
'channel' => env('MAIL_LOG_CHANNEL'),
],
'array' => [
'transport' => 'array',
],
'failover' => [
'transport' => 'failover',
'mailers' => [
'smtp',
'log',
],
'retry_after' => 60,
],
'roundrobin' => [
'transport' => 'roundrobin',
'mailers' => [
'ses',
'postmark',
],
'retry_after' => 60,
],
],
/*
|--------------------------------------------------------------------------
| Global "From" Address
|--------------------------------------------------------------------------
|
| You may wish for all emails sent by your application to be sent from
| the same address. Here you may specify a name and address that is
| used globally for all emails that are sent by your application.
|
*/
'from' => [
'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
'name' => env('MAIL_FROM_NAME', env('APP_NAME', 'Laravel')),
],
];
================================================
FILE: config/queue.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Default Queue Connection Name
|--------------------------------------------------------------------------
|
| Laravel's queue supports a variety of backends via a single, unified
| API, giving you convenient access to each backend using identical
| syntax for each. The default queue connection is defined below.
|
*/
'default' => env('QUEUE_CONNECTION', 'sync'),
/*
|--------------------------------------------------------------------------
| Queue Connections
|--------------------------------------------------------------------------
|
| Here you may configure the connection options for every queue backend
| used by your application. An example configuration is provided for
| each backend supported by Laravel. You're also free to add more.
|
| Drivers: "sync", "database", "beanstalkd", "sqs", "redis",
| "deferred", "background", "failover", "null"
|
*/
'connections' => [
'sync' => [
'driver' => 'sync',
],
'database' => [
'driver' => 'database',
'connection' => env('DB_QUEUE_CONNECTION'),
'table' => env('DB_QUEUE_TABLE', 'jobs'),
'queue' => env('DB_QUEUE', 'default'),
'retry_after' => (int) env('DB_QUEUE_RETRY_AFTER', 90),
'after_commit' => false,
],
'beanstalkd' => [
'driver' => 'beanstalkd',
'host' => env('BEANSTALKD_QUEUE_HOST', 'localhost'),
'queue' => env('BEANSTALKD_QUEUE', 'default'),
'retry_after' => (int) env('BEANSTALKD_QUEUE_RETRY_AFTER', 90),
'block_for' => 0,
'after_commit' => false,
],
'sqs' => [
'driver' => 'sqs',
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'prefix' => env('SQS_PREFIX', 'https://sqs.us-east-1.amazonaws.com/your-account-id'),
'queue' => env('SQS_QUEUE', 'default'),
'suffix' => env('SQS_SUFFIX'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
'after_commit' => false,
],
'redis' => [
'driver' => 'redis',
'connection' => env('REDIS_QUEUE_CONNECTION', 'default'),
'queue' => env('REDIS_QUEUE', 'default'),
'retry_after' => (int) env('REDIS_QUEUE_RETRY_AFTER', 90),
'block_for' => null,
'after_commit' => false,
],
'deferred' => [
'driver' => 'deferred',
],
'background' => [
'driver' => 'background',
],
'failover' => [
'driver' => 'failover',
'connections' => [
'database',
'deferred',
],
],
],
/*
|--------------------------------------------------------------------------
| Job Batching
|--------------------------------------------------------------------------
|
| The following options configure the database and table that store job
| batching information. These options can be updated to any database
| connection and table which has been defined by your application.
|
*/
'batching' => [
'database' => env('DB_CONNECTION', 'sqlite'),
'table' => 'job_batches',
],
/*
|--------------------------------------------------------------------------
| Failed Queue Jobs
|--------------------------------------------------------------------------
|
| These options configure the behavior of failed queue job logging so you
| can control how and where failed jobs are stored. Laravel ships with
| support for storing failed jobs in a simple file or in a database.
|
| Supported drivers: "database-uuids", "dynamodb", "file", "null"
|
*/
'failed' => [
'driver' => env('QUEUE_FAILED_DRIVER', 'database-uuids'),
'database' => env('DB_CONNECTION', 'sqlite'),
'table' => 'failed_jobs',
],
];
================================================
FILE: config/services.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Third Party Services
|--------------------------------------------------------------------------
|
| This file is for storing the credentials for third party services such
| as Mailgun, Postmark, AWS and more. This file provides the de facto
| location for this type of information, allowing packages to have
| a conventional file to locate the various service credentials.
|
*/
'postmark' => [
'key' => env('POSTMARK_API_KEY'),
],
'resend' => [
'key' => env('RESEND_API_KEY'),
],
'ses' => [
'key' => env('AWS_ACCESS_KEY_ID'),
'secret' => env('AWS_SECRET_ACCESS_KEY'),
'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
],
'slack' => [
'notifications' => [
'bot_user_oauth_token' => env('SLACK_BOT_USER_OAUTH_TOKEN'),
'channel' => env('SLACK_BOT_USER_DEFAULT_CHANNEL'),
],
],
'github' => [
'token' => env('GITHUB_TOKEN'),
],
];
================================================
FILE: config/session.php
================================================
<?php
use Illuminate\Support\Str;
return [
/*
|--------------------------------------------------------------------------
| Default Session Driver
|--------------------------------------------------------------------------
|
| This option determines the default session driver that is utilized for
| incoming requests. Laravel supports a variety of storage options to
| persist session data. Database storage is a great default choice.
|
| Supported: "file", "cookie", "database", "memcached",
| "redis", "dynamodb", "array"
|
*/
'driver' => env('SESSION_DRIVER', 'file'),
/*
|--------------------------------------------------------------------------
| Session Lifetime
|--------------------------------------------------------------------------
|
| Here you may specify the number of minutes that you wish the session
| to be allowed to remain idle before it expires. If you want them
| to expire immediately when the browser is closed then you may
| indicate that via the expire_on_close configuration option.
|
*/
'lifetime' => (int) env('SESSION_LIFETIME', 120),
'expire_on_close' => env('SESSION_EXPIRE_ON_CLOSE', false),
/*
|--------------------------------------------------------------------------
| Session Encryption
|--------------------------------------------------------------------------
|
| This option allows you to easily specify that all of your session data
| should be encrypted before it's stored. All encryption is performed
| automatically by Laravel and you may use the session like normal.
|
*/
'encrypt' => env('SESSION_ENCRYPT', false),
/*
|--------------------------------------------------------------------------
| Session File Location
|--------------------------------------------------------------------------
|
| When utilizing the "file" session driver, the session files are placed
| on disk. The default storage location is defined here; however, you
| are free to provide another location where they should be stored.
|
*/
'files' => storage_path('framework/sessions'),
/*
|--------------------------------------------------------------------------
| Session Database Connection
|--------------------------------------------------------------------------
|
| When using the "database" or "redis" session drivers, you may specify a
| connection that should be used to manage these sessions. This should
| correspond to a connection in your database configuration options.
|
*/
'connection' => env('SESSION_CONNECTION'),
/*
|--------------------------------------------------------------------------
| Session Database Table
|--------------------------------------------------------------------------
|
| When using the "database" session driver, you may specify the table to
| be used to store sessions. Of course, a sensible default is defined
| for you; however, you're welcome to change this to another table.
|
*/
'table' => env('SESSION_TABLE', 'sessions'),
/*
|--------------------------------------------------------------------------
| Session Cache Store
|--------------------------------------------------------------------------
|
| When using one of the framework's cache driven session backends, you may
| define the cache store which should be used to store the session data
| between requests. This must match one of your defined cache stores.
|
| Affects: "dynamodb", "memcached", "redis"
|
*/
'store' => env('SESSION_STORE'),
/*
|--------------------------------------------------------------------------
| Session Sweeping Lottery
|--------------------------------------------------------------------------
|
| Some session drivers must manually sweep their storage location to get
| rid of old sessions from storage. Here are the chances that it will
| happen on a given request. By default, the odds are 2 out of 100.
|
*/
'lottery' => [2, 100],
/*
|--------------------------------------------------------------------------
| Session Cookie Name
|--------------------------------------------------------------------------
|
| Here you may change the name of the session cookie that is created by
| the framework. Typically, you should not need to change this value
| since doing so does not grant a meaningful security improvement.
|
*/
'cookie' => env(
'SESSION_COOKIE',
Str::slug((string) env('APP_NAME', 'laravel')).'-session'
),
/*
|--------------------------------------------------------------------------
| Session Cookie Path
|--------------------------------------------------------------------------
|
| The session cookie path determines the path for which the cookie will
| be regarded as available. Typically, this will be the root path of
| your application, but you're free to change this when necessary.
|
*/
'path' => env('SESSION_PATH', '/'),
/*
|--------------------------------------------------------------------------
| Session Cookie Domain
|--------------------------------------------------------------------------
|
| This value determines the domain and subdomains the session cookie is
| available to. By default, the cookie will be available to the root
| domain without subdomains. Typically, this shouldn't be changed.
|
*/
'domain' => env('SESSION_DOMAIN'),
/*
|--------------------------------------------------------------------------
| HTTPS Only Cookies
|--------------------------------------------------------------------------
|
| By setting this option to true, session cookies will only be sent back
| to the server if the browser has a HTTPS connection. This will keep
| the cookie from being sent to you when it can't be done securely.
|
*/
'secure' => env('SESSION_SECURE_COOKIE'),
/*
|--------------------------------------------------------------------------
| HTTP Access Only
|--------------------------------------------------------------------------
|
| Setting this value to true will prevent JavaScript from accessing the
| value of the cookie and the cookie will only be accessible through
| the HTTP protocol. It's unlikely you should disable this option.
|
*/
'http_only' => env('SESSION_HTTP_ONLY', true),
/*
|--------------------------------------------------------------------------
| Same-Site Cookies
|--------------------------------------------------------------------------
|
| This option determines how your cookies behave when cross-site requests
| take place, and can be used to mitigate CSRF attacks. By default, we
| will set this value to "lax" to permit secure cross-site requests.
|
| See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value
|
| Supported: "lax", "strict", "none", null
|
*/
'same_site' => env('SESSION_SAME_SITE', 'lax'),
/*
|--------------------------------------------------------------------------
| Partitioned Cookies
|--------------------------------------------------------------------------
|
| Setting this value to true will tie the cookie to the top-level site for
| a cross-site context. Partitioned cookies are accepted by the browser
| when flagged "secure" and the Same-Site attribute is set to "none".
|
*/
'partitioned' => env('SESSION_PARTITIONED_COOKIE', false),
/*
|--------------------------------------------------------------------------
| Session Serialization
|--------------------------------------------------------------------------
|
| This value controls the serialization strategy for session data, which
| is JSON by default. Setting this to "php" allows the storage of PHP
| objects in the session but can make an application vulnerable to
| "gadget chain" serialization attacks if the APP_KEY is leaked.
|
| Supported: "json", "php"
|
*/
'serialization' => 'json',
];
================================================
FILE: config/statamic/antlers.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Debugbar
|--------------------------------------------------------------------------
|
| Here you may specify whether the Antlers profiler should be added
| to the Laravel Debugbar. This is incredibly useful for finding
| performance impacts within any of your Antlers templates.
|
*/
'debugbar' => env('STATAMIC_ANTLERS_DEBUGBAR', true),
/*
|--------------------------------------------------------------------------
| Guarded Variables
|--------------------------------------------------------------------------
|
| Any variable pattern that appears in this list will not be allowed
| in any Antlers template, including any user-supplied values.
|
*/
'guardedVariables' => [
'config.app.key',
],
/*
|--------------------------------------------------------------------------
| Guarded Tags
|--------------------------------------------------------------------------
|
| Any tag pattern that appears in this list will not be allowed
| in any Antlers template, including any user-supplied values.
|
*/
'guardedTags' => [
],
/*
|--------------------------------------------------------------------------
| Guarded Modifiers
|--------------------------------------------------------------------------
|
| Any modifier pattern that appears in this list will not be allowed
| in any Antlers template, including any user-supplied values.
|
*/
'guardedModifiers' => [
],
];
================================================
FILE: config/statamic/api.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| API
|--------------------------------------------------------------------------
|
| Whether the API should be enabled, and through what route. You
| can enable or disable the whole API, and expose individual
| resources per environment, depending on your site needs.
|
| https://statamic.dev/content-api#enable-the-api
|
*/
'enabled' => env('STATAMIC_API_ENABLED', false),
'resources' => [
'collections' => false,
'navs' => false,
'taxonomies' => false,
'assets' => false,
'globals' => false,
'forms' => false,
'users' => false,
],
'route' => env('STATAMIC_API_ROUTE', 'api'),
/*
|--------------------------------------------------------------------------
| Authentication
|--------------------------------------------------------------------------
|
| By default, the API will be publicly accessible. However, you may define
| an API token here which will be used to authenticate requests.
|
*/
'auth_token' => env('STATAMIC_API_AUTH_TOKEN'),
/*
|--------------------------------------------------------------------------
| Middleware
|--------------------------------------------------------------------------
|
| Define the middleware / middleware group that will be applied to the
| API route group. If you want to externally expose this API, here
| you can configure a middleware-based authentication layer.
|
*/
'middleware' => env('STATAMIC_API_MIDDLEWARE', 'api'),
/*
|--------------------------------------------------------------------------
| Pagination
|--------------------------------------------------------------------------
|
| The numbers of items to show on each paginated page.
|
*/
'pagination_size' => 50,
/*
|--------------------------------------------------------------------------
| Caching
|--------------------------------------------------------------------------
|
| By default, Statamic will cache each endpoint until the specified
| expiry, or until content is changed. See the documentation for
| more details on how to customize your cache implementation.
|
| https://statamic.dev/content-api#caching
|
*/
'cache' => [
'expiry' => 60,
],
/*
|--------------------------------------------------------------------------
| Exclude Keys
|--------------------------------------------------------------------------
|
| Here you may provide an array of keys to be excluded from API responses.
| For example, you may want to hide things like edit_url, api_url, etc.
|
*/
'excluded_keys' => [
//
],
];
================================================
FILE: config/statamic/assets.php
================================================
<?php
return [
'image_manipulation' => [
/*
|--------------------------------------------------------------------------
| Route Prefix
|--------------------------------------------------------------------------
|
| The route prefix for serving HTTP based manipulated images through Glide.
| If using the cached option, this should be the URL of the cached path.
|
*/
'route' => 'img',
/*
|--------------------------------------------------------------------------
| Require Glide security token
|--------------------------------------------------------------------------
|
| With this option enabled, you are protecting your website from mass image
| resize attacks. You will need to generate tokens using the Glide tag
| but may want to disable this while in development to tinker.
|
*/
'secure' => true,
/*
|--------------------------------------------------------------------------
| Image Manipulation Driver
|--------------------------------------------------------------------------
|
| The driver that will be used under the hood for image manipulation.
| Supported: "gd", "imagick" or a class name of a custom driver.
|
*/
'driver' => 'gd',
/*
|--------------------------------------------------------------------------
| Save Cached Images
|--------------------------------------------------------------------------
|
| Enabling this will make Glide save publicly accessible images. It will
| increase performance at the cost of the dynamic nature of HTTP based
| image manipulation. You will need to invalidate images manually.
|
*/
'cache' => false,
'cache_path' => public_path('img'),
/*
|--------------------------------------------------------------------------
| Image Manipulation Defaults
|--------------------------------------------------------------------------
|
| You may define global defaults for all manipulation parameters, such as
| quality, format, and sharpness. These can and will be overwritten
| on the tag parameter level as well as the preset level.
|
*/
'defaults' => [
// 'quality' => 50,
],
/*
|--------------------------------------------------------------------------
| Image Manipulation Presets
|--------------------------------------------------------------------------
|
| Rather than specifying your manipulation params in your templates with
| the glide tag, you may define them here and reference their handles.
| They may also be automatically generated when you upload assets.
| Containers can be configured to warm these caches on upload.
|
*/
'presets' => [
// 'small' => ['w' => 200, 'h' => 200, 'q' => 75, 'fit' => 'crop'],
],
/*
|--------------------------------------------------------------------------
| Generate Image Manipulation Presets on Upload
|--------------------------------------------------------------------------
|
| By default, presets will be automatically generated on upload, ensuring
| the cached images are available when they are first used. You may opt
| out of this behavior here and have the presets generated on demand.
|
*/
'generate_presets_on_upload' => true,
],
/*
|--------------------------------------------------------------------------
| Auto-Crop Assets
|--------------------------------------------------------------------------
|
| Enabling this will make Glide automatically crop assets at their focal
| point (which is the center if no focal point is defined). Otherwise,
| you will need to manually add any crop related parameters.
|
*/
'auto_crop' => true,
/*
|--------------------------------------------------------------------------
| Control Panel Thumbnail Restrictions
|--------------------------------------------------------------------------
|
| Thumbnails will not be generated for any assets any larger (in either
| axis) than the values listed below. This helps prevent memory usage
| issues out of the box. You may increase or decrease as necessary.
|
*/
'thumbnails' => [
'max_width' => 10000,
'max_height' => 10000,
],
/*
|--------------------------------------------------------------------------
| Control Panel Video Thumbnails
|--------------------------------------------------------------------------
|
| When enabled, Statamic will generate thumbnails for videos.
| Generated thumbnails are displayed in the Control Panel.
|
*/
'video_thumbnails' => true,
/*
|--------------------------------------------------------------------------
| File Previews with Google Docs
|--------------------------------------------------------------------------
|
| Filetypes that cannot be rendered with HTML5 can opt into the Google Docs
| Viewer. Google will get temporary access to these files so keep that in
| mind for any privacy implications: https://policies.google.com/privacy
|
*/
'google_docs_viewer' => false,
/*
|--------------------------------------------------------------------------
| Cache Metadata
|--------------------------------------------------------------------------
|
| Asset metadata (filesize, dimensions, custom data, etc) will get cached
| to optimize performance, so that it will not need to be constantly
| re-evaluated from disk. You may disable this option if you are
| planning to continually modify the same asset repeatedly.
|
*/
'cache_meta' => true,
/*
|--------------------------------------------------------------------------
| Focal Point Editor
|--------------------------------------------------------------------------
|
| When editing images in the Control Panel, there is an option to choose
| a focal point. When working with third-party image providers such as
| Cloudinary it can be useful to disable Statamic's built-in editor.
|
*/
'focal_point_editor' => true,
/*
|--------------------------------------------------------------------------
| Enforce Lowercase Filenames
|--------------------------------------------------------------------------
|
| Control whether asset filenames will be converted to lowercase when
| uploading and renaming. This can help you avoid file conflicts
| when working in case-insensitive filesystem environments.
|
*/
'lowercase' => true,
/*
|--------------------------------------------------------------------------
| Additional Uploadable Extensions
|--------------------------------------------------------------------------
|
| Statamic will only allow uploads of certain approved file extensions.
| If you need to allow more file extensions, you may add them here.
|
*/
'additional_uploadable_extensions' => [],
/*
|--------------------------------------------------------------------------
| Additional Filename Character Replacements
|--------------------------------------------------------------------------
|
| When uploading files, certain characters in filenames will be replaced
| to ensure a safe filename. You may configure additional replacements.
| These are in addition to the native ones. They are not overridable.
|
*/
'additional_filename_replacements' => [],
/*
|--------------------------------------------------------------------------
| SVG Sanitization
|--------------------------------------------------------------------------
|
| Statamic will automatically sanitize SVG files when uploaded to avoid
| potential security issues. However, if you have a valid reason for
| disabling this, and you trust your users, you may do so here.
|
*/
'svg_sanitization_on_upload' => true,
/*
|--------------------------------------------------------------------------
| FFmpeg
|--------------------------------------------------------------------------
|
| Statamic uses FFmpeg to extract thumbnails from videos to be shown in the
| Control Panel. You may adjust the binary location and cache path here.
|
*/
'ffmpeg' => [
'binary' => null,
'cache_path' => storage_path('statamic/glide/ffmpeg'),
],
/*
|--------------------------------------------------------------------------
| Replicator and Bard Set Preview Images
|--------------------------------------------------------------------------
|
| Replicator and Bard sets may have preview images to give users a visual
| representation of the content within. Here you may specify the asset
| container and folder where these preview images are to be stored.
|
*/
'set_preview_images' => [
'container' => 'assets',
'folder' => 'set-previews',
],
];
================================================
FILE: config/statamic/autosave.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Enable autosave
|--------------------------------------------------------------------------
|
| THIS IS A EXPERIMENTAL FEATURE. Things may go wrong.
|
| Set to true to enable autosave. You must also enable autosave
| manually in every collection in order for it to work.
|
| For example, inside `content/collections/pages.yaml`, add
| `autosave: 5000` for a 5s interval or `autosave: true`
| to use the default interval as defined below.
|
*/
'enabled' => false,
/*
|--------------------------------------------------------------------------
| Default autosave interval
|--------------------------------------------------------------------------
|
| The default value may be set here and will apply to all collections.
| However, it is also possible to manually adjust the value in the
| each collection's config file. By default, this is set to 5s.
|
*/
'interval' => 5000,
];
================================================
FILE: config/statamic/cp.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Control Panel
|--------------------------------------------------------------------------
|
| Whether the Control Panel should be enabled, and through what route.
|
*/
'enabled' => env('CP_ENABLED', true),
'route' => env('CP_ROUTE', 'cp'),
/*
|--------------------------------------------------------------------------
| Authentication
|--------------------------------------------------------------------------
|
| Whether the Control Panel's authentication pages should be enabled,
| and where users should be redirected in order to authenticate.
|
*/
'auth' => [
'enabled' => true,
'redirect_to' => null,
],
/*
|--------------------------------------------------------------------------
| Start Page
|--------------------------------------------------------------------------
|
| When a user logs into the Control Panel, they will be taken here.
| For example: "dashboard", "collections/pages", etc.
|
*/
'start_page' => 'dashboard',
/*
|--------------------------------------------------------------------------
| Dashboard Widgets
|--------------------------------------------------------------------------
|
| Here you may define any number of dashboard widgets. You're free to
| use the same widget multiple times in different configurations.
|
*/
'widgets' => [
//
],
/*
|--------------------------------------------------------------------------
| Pagination
|--------------------------------------------------------------------------
|
| Here you may define the default pagination size as well as the options
| the user can select on any paginated listing in the Control Panel.
|
*/
'pagination_size' => 50,
'pagination_size_options' => [10, 25, 50, 100, 500],
/*
|--------------------------------------------------------------------------
| Links to Documentation
|--------------------------------------------------------------------------
|
| Show contextual links to documentation throughout the Control Panel.
|
*/
'link_to_docs' => env('STATAMIC_LINK_TO_DOCS', true),
/*
|--------------------------------------------------------------------------
| Support Link
|--------------------------------------------------------------------------
|
| Set the location of the support link in the header.
|
*/
'support_url' => env('STATAMIC_SUPPORT_URL', 'https://statamic.com/support'),
/*
|--------------------------------------------------------------------------
| White Labeling
|--------------------------------------------------------------------------
|
| When in Pro Mode you may replace the Statamic name, logo, favicon,
| and add your own CSS to the control panel to match your
| company or client's brand.
|
*/
'custom_cms_name' => env('STATAMIC_CUSTOM_CMS_NAME', 'Statamic'),
'custom_logo_url' => env('STATAMIC_CUSTOM_LOGO_URL', null),
'custom_dark_logo_url' => env('STATAMIC_CUSTOM_DARK_LOGO_URL', null),
'custom_logo_text' => env('STATAMIC_CUSTOM_LOGO_TEXT', null),
'custom_favicon_url' => env('STATAMIC_CUSTOM_FAVICON_URL', null),
'custom_css_url' => env('STATAMIC_CUSTOM_CSS_URL', null),
/*
|--------------------------------------------------------------------------
| Thumbnails
|--------------------------------------------------------------------------
|
| Here you may define additional CP asset thumbnail presets.
|
*/
'thumbnail_presets' => [
// 'medium' => 800,
],
];
================================================
FILE: config/statamic/editions.php
================================================
<?php
return [
'pro' => env('STATAMIC_PRO_ENABLED', false),
'addons' => [
//
],
];
================================================
FILE: config/statamic/forms.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Forms Path
|--------------------------------------------------------------------------
|
| Where your form YAML files are stored.
|
*/
'forms' => resource_path('forms'),
/*
|--------------------------------------------------------------------------
| Email View Folder
|--------------------------------------------------------------------------
|
| The folder under resources/views where your email templates are found.
|
*/
'email_view_folder' => null,
/*
|--------------------------------------------------------------------------
| Send Email Job
|--------------------------------------------------------------------------
|
| The class name of the job that will be used to send an email.
|
*/
'send_email_job' => \Statamic\Forms\SendEmail::class,
/*
|--------------------------------------------------------------------------
| Exporters
|--------------------------------------------------------------------------
|
| Here you may define all the available form submission exporters.
| You may customize the options within each exporter's array.
|
*/
'exporters' => [
'csv' => [
'class' => Statamic\Forms\Exporters\CsvExporter::class,
],
'json' => [
'class' => Statamic\Forms\Exporters\JsonExporter::class,
],
],
];
================================================
FILE: config/statamic/git.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Git Integration
|--------------------------------------------------------------------------
|
| Whether Statamic's git integration should be enabled. This feature
| assumes that git is already installed and accessible by your
| PHP process' server user. For more info, see the docs at:
|
| https://statamic.dev/git-automation
|
*/
'enabled' => env('STATAMIC_GIT_ENABLED', false),
/*
|--------------------------------------------------------------------------
| Automatically Run
|--------------------------------------------------------------------------
|
| By default, commits are automatically queued when `Saved` or `Deleted`
| events are fired. If you prefer users to manually trigger commits
| using the `Git` utility interface, you may set this to `false`.
|
| https://statamic.dev/git-automation#committing-changes
|
*/
'automatic' => env('STATAMIC_GIT_AUTOMATIC', true),
/*
|--------------------------------------------------------------------------
| Queue Connection
|--------------------------------------------------------------------------
|
| You may choose which queue connection should be used when dispatching
| commit jobs. Unless specified, the default connection will be used.
|
| https://statamic.dev/git-automation#queueing-commits
|
*/
'queue_connection' => env('STATAMIC_GIT_QUEUE_CONNECTION'),
/*
|--------------------------------------------------------------------------
| Dispatch Delay
|--------------------------------------------------------------------------
|
| When `Saved` and `Deleted` events queue up commits, you may wish to
| set a delay time in minutes for each queued job. This can allow
| for more consolidated commits when you have multiple users
| making simultaneous content changes to your repository.
|
| Note: Not supported by default `sync` queue driver.
|
*/
'dispatch_delay' => env('STATAMIC_GIT_DISPATCH_DELAY', 0),
/*
|--------------------------------------------------------------------------
| Git User
|--------------------------------------------------------------------------
|
| The git user that will be used when committing changes. By default, it
| will attempt to commit with the authenticated user's name and email
| when possible, falling back to the below user when not available.
|
| https://statamic.dev/git-automation#git-user
|
*/
'use_authenticated' => true,
'user' => [
'name' => env('STATAMIC_GIT_USER_NAME', 'Spock'),
'email' => env('STATAMIC_GIT_USER_EMAIL', 'spock@example.com'),
],
/*
|--------------------------------------------------------------------------
| Tracked Paths
|--------------------------------------------------------------------------
|
| Define the tracked paths to be considered when staging changes. Default
| stache and file locations are already set up for you, but feel free
| to modify these paths to suit your storage config. Referencing
| absolute paths to external repos is also completely valid.
|
*/
'paths' => [
base_path('content'),
base_path('users'),
resource_path('addons'),
resource_path('blueprints'),
resource_path('fieldsets'),
resource_path('forms'),
resource_path('users'),
resource_path('preferences.yaml'),
resource_path('sites.yaml'),
storage_path('forms'),
public_path('assets'),
],
/*
|--------------------------------------------------------------------------
| Git Binary
|--------------------------------------------------------------------------
|
| By default, Statamic will try to use the "git" command, but you can set
| an absolute path to the git binary if necessary for your environment.
|
*/
'binary' => env('STATAMIC_GIT_BINARY', 'git'),
/*
|--------------------------------------------------------------------------
| Commands
|--------------------------------------------------------------------------
|
| Define a list commands to be run when Statamic is ready to `git add`
| and `git commit` your changes. These commands will be run once
| per repo, attempting to consolidate commits where possible.
|
| https://statamic.dev/git-automation#customizing-commits
|
*/
'commands' => [
'{{ git }} add {{ paths }}',
'{{ git }} -c "user.name={{ name }}" -c "user.email={{ email }}" commit -m "{{ message }}"',
],
/*
|--------------------------------------------------------------------------
| Push
|--------------------------------------------------------------------------
|
| Determine whether `git push` should be run after the commands above
| have finished. This is disabled by default, but can be enabled
| globally, or per environment using the provided variable.
|
| https://statamic.dev/git-automation#pushing-changes
|
*/
'push' => env('STATAMIC_GIT_PUSH', false),
/*
|--------------------------------------------------------------------------
| Ignored Events
|--------------------------------------------------------------------------
|
| Statamic will listen on all `Saved` and `Deleted` events, as well
| as any events registered by installed addons. If you wish to
| ignore any specific events, you may reference them here.
|
*/
'ignored_events' => [
// \Statamic\Events\UserSaved::class,
// \Statamic\Events\UserDeleted::class,
],
/*
|--------------------------------------------------------------------------
| Locale
|--------------------------------------------------------------------------
|
| The locale to be used when translating commit messages, etc. By
| default, the authenticated user's locale will be used, but
| feel free to override this using the provided variable.
|
*/
'locale' => env('STATAMIC_GIT_LOCALE', null),
];
================================================
FILE: config/statamic/graphql.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| GraphQL
|--------------------------------------------------------------------------
|
| Here you may enable the GraphQL API, and select which resources
| are available to be queried, depending on your site's needs.
|
| https://statamic.dev/graphql
|
*/
'enabled' => env('STATAMIC_GRAPHQL_ENABLED', false),
'resources' => [
'collections' => false,
'navs' => false,
'taxonomies' => false,
'assets' => false,
'globals' => false,
'forms' => false,
'sites' => false,
'users' => false,
],
/*
|--------------------------------------------------------------------------
| Queries
|--------------------------------------------------------------------------
|
| Here you may list queries to be added to the Statamic schema.
|
| https://statamic.dev/graphql#custom-queries
|
*/
'queries' => [
//
],
/*
|--------------------------------------------------------------------------
| Mutations
|--------------------------------------------------------------------------
|
| Here you may list mutations to be added to the Statamic schema.
|
| https://statamic.dev/graphql#custom-mutations
*/
'mutations' => [
//
],
/*
|--------------------------------------------------------------------------
| Middleware
|--------------------------------------------------------------------------
|
| Here you may list middleware to be added to the Statamic schema.
|
| https://statamic.dev/graphql#custom-middleware
|
*/
'middleware' => [
//
],
/*
|--------------------------------------------------------------------------
| Caching
|--------------------------------------------------------------------------
|
| By default, Statamic will cache each request until the specified
| expiry, or until content is changed. See the documentation for
| more details on how to customize your cache implementation.
|
| https://statamic.dev/graphql#caching
|
*/
'cache' => [
'expiry' => 60,
],
/*
|--------------------------------------------------------------------------
| Introspection
|--------------------------------------------------------------------------
|
| Introspection queries allow a user to see the schema and will power
| development tools. This is "auto" by default, which will enable
| it locally and keep it disabled everywhere else for security.
|
*/
'introspection' => env('STATAMIC_GRAPHQL_INTROSPECTION_ENABLED', 'auto'),
];
================================================
FILE: config/statamic/live_preview.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Devices
|--------------------------------------------------------------------------
|
| Live Preview displays a device selector for you to preview the page
| in predefined sizes. You are free to add or edit these presets.
|
*/
'devices' => [
'Laptop' => ['width' => 1440, 'height' => 900],
'Tablet' => ['width' => 1024, 'height' => 786],
'Mobile' => ['width' => 375, 'height' => 812],
],
/*
|--------------------------------------------------------------------------
| Additional Inputs
|--------------------------------------------------------------------------
|
| Additional fields may be added to the Live Preview header bar. You
| may define a list of Vue components to be injected. Their values
| will be added to the cascade on the front-end for you to use.
|
*/
'inputs' => [
//
],
/*
|--------------------------------------------------------------------------
| Force Reload Javascript Modules
|--------------------------------------------------------------------------
|
| To force a reload, Live Preview appends a timestamp to the URL on
| script tags of type 'module'. You may disable this behavior here.
|
*/
'force_reload_js_modules' => true,
/*
|--------------------------------------------------------------------------
| Hot Reload Contents
|--------------------------------------------------------------------------
|
| Should the Live Preview embed be hot-reloaded when the content changes?
| Only applies when "Refresh" is disabled on the live preview target.
|
*/
'hot_reload_contents' => true,
];
================================================
FILE: config/statamic/markdown.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Markdown Parser Configurations
|--------------------------------------------------------------------------
|
| Here you may define the configuration arrays for each markdown parser.
| You may use the base CommonMark options as well as any extensions'
| options here. The available options are in the CommonMark docs.
|
| https://statamic.dev/extending/markdown#configuration
|
*/
'configs' => [
'default' => [
'heading_permalink' => [
'id_prefix' => '',
'fragment_prefix' => '',
'apply_id_to_heading' => true,
'html_class' => 'c-anchor',
'aria_hidden' => false,
'insert' => 'after',
'symbol' => '#',
],
],
],
];
================================================
FILE: config/statamic/oauth.php
================================================
<?php
return [
'enabled' => env('STATAMIC_OAUTH_ENABLED', false),
'email_login_enabled' => true,
'providers' => [
// 'github',
],
'routes' => [
'login' => 'oauth/{provider}',
'callback' => 'oauth/{provider}/callback',
],
/*
|--------------------------------------------------------------------------
| Create User
|--------------------------------------------------------------------------
|
| Whether or not a user account should be created upon authentication
| with an OAuth provider. If disabled, a user account will be need
| to be explicitly created ahead of time.
|
*/
'create_user' => true,
/*
|--------------------------------------------------------------------------
| Merge User Data
|--------------------------------------------------------------------------
|
| When authenticating with an OAuth provider, the user data returned
| such as their name will be merged with the existing user account.
|
*/
'merge_user_data' => true,
/*
|--------------------------------------------------------------------------
| Unauthorized Redirect
|--------------------------------------------------------------------------
|
| This controls where the user is taken after authenticating with
| an OAuth provider but their account is unauthorized. This may
| happen when the create_user option has been set to false.
|
*/
'unauthorized_redirect' => null,
/*
|--------------------------------------------------------------------------
| Remember Me
|--------------------------------------------------------------------------
|
| Whether or not the "remember me" functionality should be used when
| authenticating using OAuth. When enabled, the user will remain
| logged in indefinitely, or until they manually log out.
|
*/
'remember_me' => true,
];
================================================
FILE: config/statamic/protect.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Default (or site-wide) Scheme
|--------------------------------------------------------------------------
|
| The default scheme will be applied to every page of the site.
| By default, you probably won't want to protect anything
| at all, but you are free to select one if necessary.
|
*/
'default' => null,
/*
|--------------------------------------------------------------------------
| Protection Schemes
|--------------------------------------------------------------------------
|
| Here you may define all of the protection schemes for your application
| as well as their drivers. You may even define multiple schemes for
| the same driver to easily protect different types of pages.
|
| Supported drivers: "ip_address", "auth", "password"
|
*/
'schemes' => [
'ip_address' => [
'driver' => 'ip_address',
'allowed' => ['127.0.0.1'],
],
'logged_in' => [
'driver' => 'auth',
'login_url' => '/login',
'append_redirect' => true,
],
'password' => [
'driver' => 'password',
'allowed' => ['secret'],
'field' => null,
'form_url' => null,
],
],
];
================================================
FILE: config/statamic/revisions.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Revisions
|--------------------------------------------------------------------------
|
| Revisions must be enabled per-collection by adding `revisions: true` to
| the collection's yaml file. Here you may disable revisions completely
| in one go. This is useful for disabling revisions per environment.
|
*/
'enabled' => env('STATAMIC_REVISIONS_ENABLED', false),
];
================================================
FILE: config/statamic/routes.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Enable Routes
|--------------------------------------------------------------------------
|
| Statamic adds its own routes to the front-end of your site. You are
| free to disable this behavior.
|
| More info: https://statamic.dev/routing
|
*/
'enabled' => true,
/*
|--------------------------------------------------------------------------
| Enable Route Bindings
|--------------------------------------------------------------------------
|
| Whether route bindings for Statamic repositories (entry, taxonomy,
| collections, etc) are enabled for front end routes. This may be
| useful if you want to make your own custom routes with them.
|
*/
'bindings' => false,
/*
|--------------------------------------------------------------------------
| Action Route Prefix
|--------------------------------------------------------------------------
|
| Some extensions may provide routes that go through the frontend of your
| website. These URLs begin with the following prefix. We've chosen an
| unobtrusive default but you are free to select whatever you want.
|
*/
'action' => '!',
/*
|--------------------------------------------------------------------------
| Middleware
|--------------------------------------------------------------------------
|
| Define the middleware that will be applied to the web route group.
|
*/
'middleware' => 'web',
];
================================================
FILE: config/statamic/search.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Default search index
|--------------------------------------------------------------------------
|
| This option controls the search index that gets queried when performing
| search functions without explicitly selecting another index.
|
*/
'default' => env('STATAMIC_DEFAULT_SEARCH_INDEX', 'docs-'.config('docs.version')),
/*
|--------------------------------------------------------------------------
| Search Indexes
|--------------------------------------------------------------------------
|
| Here you can define all of the available search indexes.
|
*/
'indexes' => [
'docs-'.config('docs.version') => [
'driver' => env('SEARCH_DRIVER', 'meilisearch'),
'searchables' => ['docs:*', 'storybook:*'],
'fields' => [
'title',
'search_title',
'content',
'origin_title',
'search_content',
'additional_context',
'hierarchy_lvl0',
'hierarchy_lvl1',
'url',
],
'settings' => [
'rankingRules' => [
'words',
'typo',
'proximity',
'attribute',
'exactness',
'origin_title:desc',
'hierarchy_lvl0:asc',
],
'searchableAttributes' => [
'additional_context',
'hierarchy_lvl0',
'title',
'origin_title',
'search_title',
'search_content',
'hierarchy_lvl1',
'url',
],
],
'content_retriever' => App\Search\RequestContentRetriever::class,
'document_transformers' => [
App\Search\DocTransformer::class,
],
],
],
/*
|--------------------------------------------------------------------------
| Driver Defaults
|--------------------------------------------------------------------------
|
| Here you can specify default configuration to be applied to all indexes
| that use the corresponding driver. For instance, if you have two
| indexes that use the "local" driver, both of them can have the
| same base configuration. You may override for each index.
|
*/
'drivers' => [
'local' => [
'path' => storage_path('statamic/search'),
],
'algolia' => [
'credentials' => [
'id' => env('ALGOLIA_APP_ID', ''),
'secret' => env('ALGOLIA_SECRET', ''),
],
],
'meilisearch' => [
'credentials' => [
'url' => env('MEILISEARCH_HOST', 'http://localhost:7700'),
'secret' => env('MEILISEARCH_KEY', ''),
],
],
],
/*
|--------------------------------------------------------------------------
| Search Defaults
|--------------------------------------------------------------------------
|
| Here you can specify default configuration to be applied to all indexes
| regardless of the driver. You can override these per driver or per index.
|
*/
'defaults' => [
'fields' => ['title'],
],
/*
|--------------------------------------------------------------------------
| Indexing Queue
|--------------------------------------------------------------------------
|
| Here you may configure the queue name and connection used when indexing
| documents.
|
*/
'queue' => env('STATAMIC_SEARCH_QUEUE'),
'queue_connection' => env('STATAMIC_SEARCH_QUEUE_CONNECTION'),
/*
|--------------------------------------------------------------------------
| Chunk Size
|--------------------------------------------------------------------------
|
| Here you can configure the chunk size used when indexing documents.
| The higher you make it, the more memory it will use, but the quicker
| the indexing process will be.
|
*/
'chunk_size' => 100,
];
================================================
FILE: config/statamic/stache.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| File Watcher
|--------------------------------------------------------------------------
|
| File changes will be noticed and data will be updated accordingly.
| This can be disabled to reduce overhead, but you will need to
| either update the cache manually or use the Control Panel.
|
*/
'watcher' => env('STATAMIC_STACHE_WATCHER', 'auto'),
/*
|--------------------------------------------------------------------------
| Cache Store
|--------------------------------------------------------------------------
|
| Here you may configure which Cache Store the Stache uses.
|
*/
'cache_store' => null,
/*
|--------------------------------------------------------------------------
| Stores
|--------------------------------------------------------------------------
|
| Here you may configure the stores that are used inside the Stache.
|
| https://statamic.dev/stache#stores
|
*/
'stores' => [
//
],
/*
|--------------------------------------------------------------------------
| Indexes
|--------------------------------------------------------------------------
|
| Here you may define any additional indexes that will be inherited
| by each store in the Stache. You may also define indexes on a
| per-store level by adding an "indexes" key to its config.
|
*/
'indexes' => [
//
],
/*
|--------------------------------------------------------------------------
| Locking
|--------------------------------------------------------------------------
|
| In order to prevent concurrent requests from updating the Stache at the
| same time and wasting resources, it will be locked so that subsequent
| requests will have to wait until the first one has been completed.
|
| https://statamic.dev/stache#locks
|
*/
'lock' => [
'enabled' => true,
'timeout' => 30,
],
/*
|--------------------------------------------------------------------------
| Warming Optimization
|--------------------------------------------------------------------------
|
| These options control performance optimizations during Stache warming.
|
*/
'warming' => [
// Enable parallel store processing for faster warming on multi-core systems
'parallel_processing' => env('STATAMIC_STACHE_PARALLEL_WARMING', false),
// Maximum number of parallel processes (0 = auto-detect CPU cores)
'max_processes' => env('STATAMIC_STACHE_MAX_PROCESSES', 0),
// Minimum number of stores required to enable parallel processing
'min_stores_for_parallel' => env('STATAMIC_STACHE_MIN_STORES_PARALLEL', 3),
// Concurrency driver: 'process', 'fork', or 'sync'
'concurrency_driver' => env('STATAMIC_STACHE_CONCURRENCY_DRIVER', 'process'),
],
];
================================================
FILE: config/statamic/static_caching.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Active Static Caching Strategy
|--------------------------------------------------------------------------
|
| To enable Static Caching, you should choose a strategy from the ones
| you have defined below. Leave this null to disable static caching.
|
*/
'strategy' => env('STATAMIC_STATIC_CACHING_STRATEGY', null),
/*
|--------------------------------------------------------------------------
| Caching Strategies
|--------------------------------------------------------------------------
|
| Here you may define all of the static caching strategies for your
| application as well as their drivers.
|
| Supported drivers: "application", "file"
|
*/
'strategies' => [
'half' => [
'driver' => 'application',
'expiry' => null,
],
'full' => [
'driver' => 'file',
'path' => public_path('static'),
'lock_hold_length' => 0,
'permissions' => [
'directory' => 0755,
'file' => 0644,
],
],
],
/*
|--------------------------------------------------------------------------
| Exclusions
|--------------------------------------------------------------------------
|
| Here you may define a list of URLs to be excluded from static
| caching. You may want to exclude URLs containing dynamic
| elements like contact forms, or shopping carts.
|
*/
'exclude' => [
'class' => null,
'urls' => [
'/sitemap.xml',
],
],
/*
|--------------------------------------------------------------------------
| Invalidation Rules
|--------------------------------------------------------------------------
|
| Here you may define the rules that trigger when and how content would be
| flushed from the static cache. See the documentation for more details.
| If a custom class is not defined, the default invalidator is used.
|
| https://statamic.dev/static-caching
|
*/
'invalidation' => [
'class' => null,
'rules' => [
//
],
],
/*
|--------------------------------------------------------------------------
| Ignoring Query Strings
|--------------------------------------------------------------------------
|
| Statamic will cache pages of the same URL but with different query
| parameters separately. This is useful for pages with pagination.
| If you'd like to ignore the query strings, you may do so.
|
*/
'ignore_query_strings' => false,
'allowed_query_strings' => [
//
],
'disallowed_query_strings' => [
//
],
/*
|--------------------------------------------------------------------------
| Nocache
|--------------------------------------------------------------------------
|
| Here you may define where the nocache data is stored.
|
| https://statamic.dev/tags/nocache#database
|
| Supported drivers: "cache", "database"
|
*/
'nocache' => 'cache',
'nocache_db_connection' => env('STATAMIC_NOCACHE_DB_CONNECTION'),
/*
|--------------------------------------------------------------------------
| Replacers
|--------------------------------------------------------------------------
|
| Here you may define replacers that dynamically replace content within
| the response. Each replacer must implement the Replacer interface.
|
*/
'replacers' => [
\Statamic\StaticCaching\Replacers\CsrfTokenReplacer::class,
\Statamic\StaticCaching\Replacers\NoCacheReplacer::class,
],
/*
|--------------------------------------------------------------------------
| Warm Queue
|--------------------------------------------------------------------------
|
| Here you may define the queue name and connection
| that will be used when warming the static cache and
| optionally set the "--insecure" flag by default.
|
*/
'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),
'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),
'warm_insecure' => env('STATAMIC_STATIC_WARM_INSECURE', false),
/*
|--------------------------------------------------------------------------
| Background Re-cache
|--------------------------------------------------------------------------
|
| When this is enabled, Statamic will re-cache URLs in the background,
| overwriting the existing cache, without removing it first.
|
*/
'background_recache' => env('STATAMIC_BACKGROUND_RECACHE', false),
'recache_token' => env('STATAMIC_RECACHE_TOKEN'),
'recache_token_parameter' => '__recache',
/*
|--------------------------------------------------------------------------
| Shared Error Pages
|--------------------------------------------------------------------------
|
| You may choose to share the same statically generated error page across
| all errors. For example, the first time a 404 is encountered it will
| be generated and cached, and then served for all subsequent 404s.
|
| This is only supported for half measure.
|
*/
'share_errors' => false,
];
================================================
FILE: config/statamic/system.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| License Key
|--------------------------------------------------------------------------
|
| The license key for the corresponding domain from your Statamic account.
| Without a key entered, your app will be considered to be in Trial Mode.
|
| https://statamic.dev/licensing#trial-mode
|
*/
'license_key' => env('STATAMIC_LICENSE_KEY'),
/*
|--------------------------------------------------------------------------
| Enable Multi-site
|--------------------------------------------------------------------------
|
| Whether Statamic's multi-site functionality should be enabled. It is
| assumed Statamic Pro is also enabled. To get started, you can run
| the `php please multisite` command to update your content file
| structure, after which you can manage your sites in the CP.
|
| https://statamic.dev/multi-site
|
*/
'multisite' => false,
/*
|--------------------------------------------------------------------------
| Default Addons Paths
|--------------------------------------------------------------------------
|
| When generating addons via `php please make:addon`, this path will be
| used by default. You can still specify custom repository paths in
| your composer.json, but this is the path used by the generator.
|
*/
'addons_path' => base_path('addons'),
/*
|--------------------------------------------------------------------------
| Blueprints Path
|--------------------------------------------------------------------------
|
| Where your blueprint YAML files are stored.
|
*/
'blueprints_path' => resource_path('blueprints'),
/*
|--------------------------------------------------------------------------
| Fieldsets Path
|--------------------------------------------------------------------------
|
| Where your fieldset YAML files are stored.
|
*/
'fieldsets_path' => resource_path('fieldsets'),
/*
|--------------------------------------------------------------------------
| Send the Powered-By Header
|--------------------------------------------------------------------------
|
| Websites like builtwith.com use the X-Powered-By header to determine
| what technologies are used on a particular site. By default, we'll
| send this header, but you are absolutely allowed to disable it.
|
*/
'send_powered_by_header' => true,
/*
|--------------------------------------------------------------------------
| Date Format
|--------------------------------------------------------------------------
|
| This format will be used whenever a Carbon date is cast to a string on
| front-end routes. It doesn't affect how dates are formatted in the CP.
| You can customize this format using PHP's date string constants.
| Setting this value to null will use Carbon's default format.
|
| https://www.php.net/manual/en/function.date.php
|
*/
'date_format' => 'F jS, Y',
/*
|--------------------------------------------------------------------------
| Timezone
|--------------------------------------------------------------------------
|
| Statamic will use this timezone when displaying dates on the front-end.
| You can use any timezone supported by PHP. When set to null it will
| fall back to the timezone defined in your `app.php` config file.
|
| https://www.php.net/manual/en/timezones.php
|
*/
'display_timezone' => null,
/*
|--------------------------------------------------------------------------
| Localize Dates in Modifiers
|--------------------------------------------------------------------------
|
| When using date-related modifiers, Carbon instances will be in UTC.
| Enabling this setting will ensure that dates get localized into
| the timezone defined in `display_timezone`. Otherwise you'll
| need to manually localize dates in all of your templates.
|
*/
'localize_dates_in_modifiers' => true,
/*
|--------------------------------------------------------------------------
| Default Character Set
|--------------------------------------------------------------------------
|
| Statamic will use this character set when performing specific string
| encoding and decoding operations; This does not apply everywhere.
|
*/
'charset' => 'UTF-8',
/*
|--------------------------------------------------------------------------
| Track Last Update
|--------------------------------------------------------------------------
|
| Statamic will automatically set an `updated_at` timestamp (along with
| `updated_by`, where applicable) when specific content is updated.
| In some situations, you may wish disable this functionality.
|
*/
'track_last_update' => false,
/*
|--------------------------------------------------------------------------
| Enable Cache Tags
|--------------------------------------------------------------------------
|
| Sometimes you'll want to be able to disable the {{ cache }} tags in
| Antlers, so here is where you can do that. Otherwise, it will be
| enabled all the time.
|
*/
'cache_tags_enabled' => env('STATAMIC_CACHE_TAGS_ENABLED', true),
/*
|--------------------------------------------------------------------------
| Intensive Operations
|--------------------------------------------------------------------------
|
| Sometimes Statamic requires extra resources to complete intensive
| operations. Here you may configure system resource limits for
| those rare times when we need to turn things up to eleven!
|
*/
'php_memory_limit' => '-1',
'php_max_execution_time' => '-1',
'ajax_timeout' => '600000',
'pcre_backtrack_limit' => '-1',
/*
|--------------------------------------------------------------------------
| Debugbar Integration
|--------------------------------------------------------------------------
|
| Statamic integrates with Laravel Debugbar to bring more detail to your
| debugging experience. Here you may adjust various default options.
|
*/
'debugbar' => [
'pretty_print_variables' => true,
],
/*
|--------------------------------------------------------------------------
| ASCII
|--------------------------------------------------------------------------
|
| During various string manipulations (e.g. slugification), Statamic will
| need to make ASCII character conversions. Here you may define whether
| or not extra characters get converted. e.g. "%" becomes "percent".
|
*/
'ascii_replace_extra_symbols' => false,
/*
|--------------------------------------------------------------------------
| Update References on Change
|--------------------------------------------------------------------------
|
| With this enabled, Statamic will attempt to update references to assets
| and terms when moving, renaming, replacing, deleting, etc. This will
| be queued, but it can disabled as needed for performance reasons.
|
*/
'update_references' => true,
/*
|--------------------------------------------------------------------------
| Always Augment to Query
|--------------------------------------------------------------------------
|
| By default, Statamic will augment relationship fields with max_items: 1
| to the result of a query, for example an Entry instance. Setting this
| to true will augment to the query builder instead of the result.
|
*/
'always_augment_to_query' => false,
/*
|--------------------------------------------------------------------------
| Row ID handle
|--------------------------------------------------------------------------
|
| Rows in Grid, Replicator, and Bard fields will be given a unique ID using
| the "id" field. You may need your own field named "id", in which case
| you may customize the handle of the field that Statamic will use.
|
*/
'row_id_handle' => 'id',
/*
|--------------------------------------------------------------------------
| Fake SQL Queries
|--------------------------------------------------------------------------
|
| Enable while using the flat-file Stache driver to show fake "SQL" query
| approximations in your database debugging tools — including Debugbar,
| Laravel Telescope, and Ray with the ray()->showQueries() helper.
|
*/
'fake_sql_queries' => config('app.debug'),
/*
|--------------------------------------------------------------------------
| Layout
|--------------------------------------------------------------------------
|
| Define the default layout that will be used by views.
|
*/
'layout' => env('STATAMIC_LAYOUT', 'layout'),
/*
|--------------------------------------------------------------------------
| View Config Allowlist
|--------------------------------------------------------------------------
|
| Config keys that are allowed to be accessed in Antlers templates. Use
| '@default' to include Statamic's default list. Add 'docs' so the docs
| version switcher can access config.docs.version and config.docs.versions.
|
*/
'view_config_allowlist' => ['@default', 'docs'],
];
================================================
FILE: config/statamic/templates.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Template Language
|--------------------------------------------------------------------------
|
| The preferred templated language to use when scaffolding templates.
|
| Acceptable values are 'blade' and 'antlers'
*/
'language' => 'antlers',
/*
|--------------------------------------------------------------------------
| Code Style
|--------------------------------------------------------------------------
|
| Here you may configure the code generator's output style.
|
*/
'style' => [
'line_ending' => 'auto',
'indent_type' => 'space',
'indent_size' => 4,
'final_newline' => false,
],
/*
|--------------------------------------------------------------------------
| Antlers Settings
|--------------------------------------------------------------------------
|
| Antlers specific template generation settings.
|
*/
'antlers' => [
'use_components' => false,
],
];
================================================
FILE: config/statamic/users.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| User Repository
|--------------------------------------------------------------------------
|
| Statamic uses a repository to get users, roles, groups, and their
| relationships from specified storage locations. The file driver
| gets it from disk, while the eloquent driver gets from a DB.
|
| Supported: "file", "eloquent"
|
*/
'repository' => 'file',
'repositories' => [
'file' => [
'driver' => 'file',
'paths' => [
'roles' => resource_path('users/roles.yaml'),
'groups' => resource_path('users/groups.yaml'),
],
],
'eloquent' => [
'driver' => 'eloquent',
],
],
/*
|--------------------------------------------------------------------------
| Avatars
|--------------------------------------------------------------------------
|
| User avatars are initials by default, with custom options for services
| like Gravatar.com.
|
| Supported: "initials", "gravatar", or a custom class name.
|
*/
'avatars' => 'initials',
/*
|--------------------------------------------------------------------------
| New User Roles
|--------------------------------------------------------------------------
|
| When registering new users through the user:register_form tag, these
| roles will automatically be applied to your newly created users.
|
*/
'new_user_roles' => [
//
],
/*
|--------------------------------------------------------------------------
| New User Groups
|--------------------------------------------------------------------------
|
| When registering new users through the user:register_form tag, these
| groups will automatically be applied to your newly created users.
|
*/
'new_user_groups' => [
//
],
/*
|--------------------------------------------------------------------------
| Registration form honeypot field
|--------------------------------------------------------------------------
|
| When registering new users through the user:register_form tag,
| specify the field to act as a honeypot for bots
|
*/
'registration_form_honeypot_field' => null,
/*
|--------------------------------------------------------------------------
| User Wizard Invitation Email
|--------------------------------------------------------------------------
|
| When creating new users through the wizard in the control panel,
| you may choose whether to be able to send an invitation email.
| Setting to true will give the user the option. But setting
| it to false will disable the invitation option entirely.
|
*/
'wizard_invitation' => true,
/*
|--------------------------------------------------------------------------
| Password Brokers
|--------------------------------------------------------------------------
|
| When resetting passwords, Statamic uses an appropriate password broker.
| Here you may define which broker should be used for each situation.
| You may want a longer expiry for user activations, for example.
|
*/
'passwords' => [
'resets' => 'users',
'activations' => 'activations',
],
/*
|--------------------------------------------------------------------------
| Database
|--------------------------------------------------------------------------
|
| Here you may configure the database connection and its table names.
|
*/
'database' => config('database.default'),
'tables' => [
'users' => 'users',
'role_user' => 'role_user',
'roles' => false,
'group_user' => 'group_user',
'groups' => false,
'webauthn' => 'webauthn',
],
/*
|--------------------------------------------------------------------------
| Authentication Guards
|--------------------------------------------------------------------------
|
| By default, Statamic will use the `web` authentication guard. However,
| if you want to run Statamic alongside the default Laravel auth
| guard, you can configure that for your cp and/or frontend.
|
*/
'guards' => [
'cp' => 'web',
'web' => 'web',
],
/*
|--------------------------------------------------------------------------
| Impersonation
|--------------------------------------------------------------------------
|
| Here you can configure if impersonation is available, and what URL to
| redirect to after impersonation begins.
|
*/
'impersonate' => [
'enabled' => env('STATAMIC_IMPERSONATE_ENABLED', true),
'redirect' => env('STATAMIC_IMPERSONATE_REDIRECT', null),
],
/*
|--------------------------------------------------------------------------
| Elevated Sessions
|--------------------------------------------------------------------------
|
| Users may be required to reauthorize before performing certain
| sensitive actions. This is called an elevated session. Here
| you may configure the duration of the session in minutes.
|
*/
'elevated_session_duration' => 15,
/*
|--------------------------------------------------------------------------
| Enforce Two-Factor Authentication
|--------------------------------------------------------------------------
|
| Specify which user roles should be required to enable two-factor
| authentication. Use "*" to enforce 2FA for all users, or "super_users"
| to enforce it for super users.
|
*/
'two_factor_enforced_roles' => [],
/*
|--------------------------------------------------------------------------
| Default Sorting
|--------------------------------------------------------------------------
|
| Here you may configure the default sort behavior for user listings.
|
*/
'sort_field' => 'email',
'sort_direction' => 'asc',
];
================================================
FILE: config/statamic/webauthn.php
================================================
<?php
return [
/*
|--------------------------------------------------------------------------
| Allow password logins to be used when user has a passkey
|--------------------------------------------------------------------------
|
| Whether or not the password field should be shown to users that
| have set up a passkey, or whether it should be hidden.
|
*/
'allow_password_login_with_passkey' => true,
/*
|--------------------------------------------------------------------------
| Remember Me
|--------------------------------------------------------------------------
|
| Whether or not the "remember me" functionality should be used when
| authenticating using WebAuthn. When enabled, the user will remain
| logged in indefinitely, or until they manually log out.
|
*/
'remember_me' => true,
/*
|--------------------------------------------------------------------------
| Model
|--------------------------------------------------------------------------
|
| When using eloquent passkeys you can specify the model you want to use
|
*/
'model' => \Statamic\Auth\Eloquent\WebAuthnModel::class,
];
================================================
FILE: config/torchlight.php
================================================
<?php
return [
// The Torchlight client caches highlighted code blocks. Here
// you can define which cache driver you'd like to use. If
// leave this blank your default app cache will be used.
'cache' => env('TORCHLIGHT_CACHE_DRIVER'),
// Which theme you want to use. You can find all of the themes at
// https://torchlight.dev/docs/themes.
'theme' => env('TORCHLIGHT_THEME', 'synthwave-84'),
// Your API token from torchlight.dev.
'token' => env('TORCHLIGHT_TOKEN'),
// If you want to register the blade directives, set this to true.
'blade_components' => false,
// The Host of the API.
'host' => env('TORCHLIGHT_HOST', 'https://api.torchlight.dev'),
// We replace tabs in your code blocks with spaces in HTML. Set
// the number of spaces you'd like to use per tab. Set to
// `false` to leave literal tabs in the HTML.
'tab_width' => 4,
// If you pass a filename to the code component or in a markdown
// block, Torchlight will look for code snippets in the
// following directories.
'snippet_directories' => [
resource_path(),
],
// Global options to control blocks-level settings.
// https://torchlight.dev/docs/options
'options' => [
// Turn line numbers on or off globally.
'lineNumbers' => false,
'defaultLanguage' => 'antlers',
// Control the `style` attribute applied to line numbers.
// 'lineNumbersStyle' => '',
'fileStyle' => 'html',
// Turn on +/- diff indicators.
// 'diffIndicators' => true,
// If there are any diff indicators for a line, put them
// in place of the line number to save horizontal space.
// 'diffIndicatorsInPlaceOfLineNumbers' => true,
// When lines are collapsed, this is the text that will
// be shown to indicate that they can be expanded.
// 'summaryCollapsedIndicator' => '...',
],
];
================================================
FILE: content/assets/.gitkeep
================================================
================================================
FILE: content/assets/main.yaml
================================================
title: Main
disk: assets
================================================
FILE: content/collections/.gitkeep
================================================
================================================
FILE: content/collections/fieldtypes/array.md
================================================
---
title: Array
meta_title: Array Fieldtype
intro: Manage data in a `key:value` array format.
overview: |
The array fieldtype is used to manage `key: value` array data. It's similar to the [table](/fieldtypes/table) fieldtype but with a more strict data structure and compact user interface.
screenshot: fieldtypes/screenshots/v6/array.webp
screenshot_dark: fieldtypes/screenshots/v6/array-dark.webp
options:
-
name: keys
type: array
description: >
Define keys when using [keyed mode](#keyed-mode).
Default: `null`.
-
name: mode
type: string
description: "Determine which [mode](#modes) to use. Default: `dynamic`."
-
name: value_header
type: string
description: >
**Value** column heading displayed when using [dynamic mode](#dynamic-mode)
Default: `Value`.
-
name: key_header
type: string
description: >
**Key** column heading displayed when using [dynamic mode](#dynamic-mode)
Default: `Key`.
-
name: add_button
type: string
description: >
Add button text customization.
Default: `Add Row`.
-
name: expand
type: boolean
description: >
Save the field as an ordered list of `key` / `value` objects instead of a flat YAML mapping.
Enable when you need numeric keys, stable option order with database-backed content stores, or to avoid YAML limitations with certain key types.
Default: `false`.
id: 457f17eb-c0ee-4345-bf90-88322abc212d
---
## Overview
This fieldtype is used to manage `key: value` array data in the right situation. It's used for situations when there is data you would like to stay grouped together because there's only _one_ set and you don't want to use loops.
If you'd like to have _lists_ of this type of data, you might want to use a [grid](/fieldtypes/grid) or [replicator](/fieldtypes/replicator) field.
## Modes
The screenshot above depicts the three modes you can choose from. Two for when you know there is a fixed set of keys (keyed/single), and one for when you don't (dynamic).
### Keyed Mode
The first field contains pre-defined keys. This will give the user a stricter input. They can only enter the values for the specified keys, and they cannot be reordered.
```yaml
address:
type: array
keys:
street: Street
city: City
country: Country
```
The keys can be specified with or without labels. The snippet above (and what's shown in the screenshot) uses labels.
The following is an example of just keys. When using this syntax, the key and the label will be identical.
```
keys:
- street
- city
- country
```
### Single Mode
Exactly the same restrictions and setup as keyed mode, except the user can only manage an array one item at a time, using a select box to switch between keys.
### Dynamic Mode
The second field contains no pre-defined keys. This will allow the user to define them on the fly and re-arrange them.
```yaml
address:
type: array
```
Column headings can be set with `value_header` & `key_header`.
```
value_header: Type of Bacon
key_header: Why is it awesome?
```
### Expanded storage (`expand`) {#expanded-storage}
By default, array data is stored as a YAML mapping (`key: value`). Set `expand: true` to store it as an ordered list of objects instead:
```yaml
# expand: false (default)
sizes:
"42": Medium
"7": Small
# expand: true
sizes:
-
key: "42"
value: Medium
-
key: "7"
value: Small
```
Use expanded storage when keys need to be **numbers** (YAML mappings treat numeric keys oddly), when you rely on **explicit row order** (for example with the Eloquent Driver and MySQL, where key order on associative arrays is not preserved), or when you edit raw YAML and want unambiguous structure.
```yaml
inventory:
type: array
expand: true
keys:
sku: SKU
qty: Quantity
```
[Augmentation](/augmentation) still exposes the field as a normal key/value structure for templates and Antlers, so `{{ inventory:sku }}` and nested variable syntax behave the same whether `expand` is on or off.
## Data Structure
In the example above, the keyed mode and dynamic mode would save the exact same data (unless [expanded storage](#expanded-storage) is enabled—in that case the same logical keys are stored as a list of `key` / `value` objects).
```yaml
address:
street: 221B Baker Street
city: London
country: England
```
Single mode will only save data if it has been entered by the user.
```yaml
address:
England: '221 Baker Street, London'
```
## Templating
This fieldtype _is not_ [augmented](/augmentation).
::tabs
You can use basic array access, nested variables, or the [foreach tag](/tags/foreach) to loop through all of the keys. All three of the following methods are equivalent.
```antlers
// Array access
{{ address }}
{{ street }} {{ city }} {{ country }}
{{ /address }}
// Nested variables
{{ address:street }} {{ address:city }} {{ address:country }}
// Foreach tag:
{{ foreach:address }}
{{ value }}
{{ /foreach:address }}
```
::tab
You can use basic array access or the `@foreach` directive to loop through all of the keys.
```blade
// Nested variables
{{ $address['street'] }}
{{ $address['city'] }}
{{ $address['country'] }}
// Using foreach
@foreach ($address as $key => $value)
{{ $key }}: {{ $value }}
@endforeach
```
::
================================================
FILE: content/collections/fieldtypes/assets.md
================================================
---
title: Assets
meta_title: Assets Fieldtype
intro: Any time you want to list, display, or work with assets (external files with enhanced abilities), this is the way to do it. Upload, browse, reorder, delete, and even manage field data on individual assets.
description: Upload files and use the Asset Browser to pick from existing files in your Asset Containers.
screenshot: fieldtypes/screenshots/v6/assets-list.webp
screenshot_dark: fieldtypes/screenshots/v6/assets-list-dark.webp
options:
-
name: allow_uploads
type: bool
description: |
Enable to allow uploading new files into the container. Default: `true`.
-
name: container
type: string
description: |
The name of the desired [asset container](/assets#containers) to use for browsing, uploading, and managing assets. _Required when the site has more than one container._
-
name: folder
type: string
description: >
The folder (relative to the container) to begin browsing. Default: the root folder of the container.
-
name: dynamic
type: string
description:
Assets will be placed in a subfolder based on the value of this field. See [dynamic folders](#dynamic-folders). You may use `id`, `slug`, or `author`.
-
name: min_files
type: int
description: >
The minimum number of allowed files. Leave empty for no minimum.
-
name: max_files
type: int
description: >
The maximum number of allowed files. Set to `null` for unlimited. If set to `1`, will be saved as a string instead of an array. Default: `null`.
-
name: mode
type: string
description: >
Set to `list` to use the table layout mode, and `grid` to use the grid mode with larger thumbnails. Default: `grid`.
-
name: query_scopes
type: string
description: >
Allows you to specify a [query scope](/extending/query-scopes-and-filters#scopes) which should be applied when retrieving selectable assets. You should specify the query scope's handle, which is usually the name of the class in snake case. For example: `MyAwesomeScope` would be `my_awesome_scope`.
-
name: restrict
type: bool
description: >
If `true`, navigation within the asset browser will be disabled. Your users will be restricted to a specified container and folder. Default: `false`.
id: d0c65546-74f1-4a15-89d5-1562a95ee2c6
---
## Overview
The assets fieldtype is used to manage and relate files with your entries. From the fieldtype you can manage custom fields on the assets themselves (learn more about that in the [assets guide](/assets)), preview full size images or rich media files, and even set focal points for cropping.
Files are rearrangeable via drag-and-drop.
## UI Modes
The list mode is shown in the previous screenshot, while the grid mode is shown below. There are no functional differences, only visual ones. List mode is more compact – useful if you're not primarily managing images.
<figure>
<img src="/img/fieldtypes/screenshots/v6/assets-grid.webp" alt="Assets List mode" class="u-hide-in-dark-mode">
<img src="/img/fieldtypes/screenshots/v6/assets-grid-dark.webp" alt="Assets List mode" class="u-hide-in-light-mode">
<figcaption>List mode reveals a fanny pack in all its glory. And if you’re British—go on, have a little chuckle.</figcaption>
</figure>
## Data Structure
Data is stored as an array of image paths _relative to the asset container_. Each asset's full URL is generated dynamically on the frontend based on the image path and its container. This allows containers to be a bit more portable by avoiding fully hardcoded file paths.
If `max_files` is set to `1`, a string will be saved instead of an array.
``` yaml
# Default YAML
gallery_images:
- fresh-prince.jpg
- dj-jazzy-jeff.jpg
- uncle-phil.jpg
# With max_files: 1
hero_image: surf-boards.jpg
```
## Templating
The Asset fieldtype uses [augmentation](/augmentation) to automatically relate the files with their Asset records, pull in custom and meta data, and resolve all image paths based on the container.
::tabs
By using a tag pair syntax, you'll be able to output variables for each asset:
```antlers
{{ gallery_images }}
<img src="{{ url }}" alt="{{ alt }}" />
{{ /gallery_images }}
{{ hero_image }}
<img src="{{ url }}" alt="{{ alt }}" />
{{ /hero_image }}
```
::tab
You can use the `@foreach` directive to loop over each asset and output its variables:
```blade
@foreach ($gallery_images as $asset)
<img src="{{ $asset->url }}" alt="{{ $asset->alt }}" />
@endforeach
{{-- Assuming $hero_image is max_files: 1 --}}
<img src="{{ $hero_image->url }}" alt="{{ $hero_image->alt }}" />
```
::
```html
<img src="/assets/fresh-prince.jpg" alt="Will Smith as the Fresh Prince" />
<img src="/assets/dj-jazzy-jeff.jpg" alt="Jeffrey Allen Townes as DJ Jazzy Jeff" />
<img src="/assets/uncle-phil.jpg" alt="James Avery as Uncle Phil" />
<img src="/assets/surf-boards.jpg" alt="3 colorful surf boards" />
```
The same tag pair syntax can be used regardless of your `max_files` setting.
::tabs
If you have `max_files: 1`, you can also use a single tag syntax to directly use a variable inside the asset. Without a second tag part, the URL will be used.
```antlers
{{ hero_image }}
{{ hero_image:url }}
{{ hero_image:alt }}
```
::tab
If you have `max_files: 1`, you can use property access to output variables within the asset. When output as a string, the URL will be used.
```blade
{{ $hero_image }}
{{ $hero_image->url }}
{{ $hero_image->alt }}
```
::
```html
/assets/surf-boards.jpg
/assets/surf-boards.jpg
3 colorful surf boards
```
### Variables
Inside an asset variable's tag pair you'll have access to the following variables.
| Variable | Description |
|----------|-------------|
| `url` | Web-friendly URL to the file. |
| `path` | Path to the file relative to asset container |
| `permalink` | Absolute URL to the file including your site URL. |
| `basename` | Name of the file with file extension |
| `blueprint` | Which blueprint is managing the asset container |
| `container` | Which asset container the file is in |
| `edit_url` | URL to edit asset in the Control Panel |
| `extension` | File extension |
| `filename` | Name of the file without file extension |
| `folder` | Which folder the file is in |
| `is_audio` | `true` when file is one of `aac`, `flac`, `m4a`, `mp3`, `ogg`, or `wav`. |
| `is_image` | `true` when file is one of `jpg`, `jpeg`, `png`, `gif`, or `webp`. |
| `is_svg` | `true` when file is an `svg`. |
| `is_video` | `true` when file is one of `h264`, `mp4`, `m4v`, `ogv`, or `webm`. |
| `last_modified` | Formatted date string of the last modified time |
| `last_modified_instance` | [Carbon][carbon] instance of the last modified time |
| `last_modified_timestamp` | Unix timestamp of the last modified time |
| `size` | Pre-formatted file size (`3.48 MB`) |
| `size_b` | File size in bytes |
| `size_kb` | File size in kilobytes |
| `size_mb` | File size in megabytes |
| `size_gb` | File size in gigabytes |
### Image Assets
| Variable | Description |
|----------|-------------|
| `height` | height of an image, in pixels |
| `width` | width of an image, in pixels |
| `focus_css` | CSS `background-image` property for a focal point
| `orientation` | Is one of `portrait`, `landscape`, `square`, or `null`. |
| `ratio` | An image's ratio (`1.77`) |
:::tip
You can use [Glide](/tags/glide) to crop, flip, sharpen, pixelate, and perform other sweet image manipulations.
:::
### Asset Field Data
::tabs
All custom data set on the assets will also be available inside the asset tag loop.
```antlers
{{ gallery_images }}
<figure>
<img src="{{ url }}" alt="{{ alt }}">
<figcaption>{{ caption }}</figcaption>
</figure>
{{ /gallery_images }}
```
::tab
All custom data set on the assets will also be available on the asset instance.
```blade
@foreach ($gallery_images as $image)
<img src="{{ $image->url }}" alt="{{ $image->alt }}" />
@if ($caption = $image->caption)
<figcaption>{{ $caption }}</figcaption>
@endif
@endforeach
```
::
## Dynamic Folders
In addition to selecting which container and folder assets will be uploaded into, you may configure the field to have a dedicated subfolder based on an entry's value.
For example, you may want to place all the images for a blog post in its own directory.
```yaml
type: assets
container: images
folder: blog
dynamic: slug
```
This would result in `image.jpg` being uploaded to `path/to/images/blog/my-entry-slug/image.jpg`.
You may target the entry's `id`, `slug`, or `author` values.
:::warning
The values are *not* kept in sync. For example, if you change the entry's slug, the asset folder will not be renamed. You may rename the folder manually via a control on the field, or within the asset browser.
:::
[carbon]: https://carbon.nesbot.com/docs/
================================================
FILE: content/collections/fieldtypes/bard.md
================================================
---
title: Bard
description: "Rich article writing and block-based layouts made easy."
intro: |
Bard is more than just a content editor, and more flexible than a block-based editor. **It is designed to provide a delightful and powerful writing experience** with unparalleled flexibility on your front-end.
screenshot: fieldtypes/screenshots/v6/bard-with-sets.webp
screenshot_dark: fieldtypes/screenshots/v6/bard-with-sets-dark.webp
options:
-
name: allow_source
type: boolean
description: |
Controls whether the "show source code" button is available to your editors. Default: `true`.
-
name: sets
type: array
description: An array containing sets of fields. If you don't provide any sets, Bard will act like a basic text/WYSIWYG editor and you won't see the "Add Set" button.
-
name: buttons
type: array
description: |
An array of buttons you want available in the toolbar.
You can choose from `h1`, `h2`, `h3`, `h4`, `h5`, `h6`, `bold`, `italic`, `small`, `underline`, `strikethrough`, `unorderedlist`, `orderedlist`, `removeformat`, `quote`, `anchor`, `image`, `table`, `code` (inline), `codeblock`, and `horizontalrule`.
These are the defaults:
 {.mt-4}
You can override the default buttons using the `Bard::setDefaultButtons()` method:
```php
\Statamic\Fieldtypes\Bard::setDefaultButtons(['h2', 'h3', 'bold', 'italic']);
```
When you have the `image` button toggled, make sure to define an Asset Container in the Bard field's settings, otherwise the button won't show.
-
name: target_blank
type: boolean
description: |
Automatically add `target="_blank"` on links by default. You'll be able to override this per-link. Default: `false`.
-
name: link_noopener
type: boolean
description: |
Set `rel="noopener"` on all created links. Default: `false`.
-
name: link_noreferrer
type: boolean
description: |
Set `rel="noreferrer"` on all created links. Default: `false`.
-
name: fullscreen
type: boolean
description: |
Enable the option to toggle into fullscreen mode. Default: `true`.
-
name: collapse
type: boolean
description: >
Expand (`true`) or collapse (`false`) all sets by default. Default: `false`.
-
name: container
type: string
description: >
An asset container ID. When specified, the fieldtype will allow the user to add a link to an asset from the specified container.
-
name: inline
type: boolean
description: |
Switch the field to inline mode. Block elements such as sets, headings and images are not supported in inline mode and should not be enabled.
-
name: inline_hard_breaks
type: boolean
description: |
Enable support for hard breaks in inline mode. Only works when `inline` is set to `true`. Default: `false`.
-
name: toolbar_mode
type: string
description: >
Choose which style of toolbar you prefer, `fixed` or `floating`. Default: `fixed`.
-
name: reading_time
type: boolean
description: >
Show estimated reading time at the bottom of the field. Default: `false`.
-
name: word_count
type: boolean
description: >
Show the word count at the bottom of the field. Default: `false`.
-
name: save_html
type: boolean
description: >
Save as HTML instead of structured data. This simplifies templates so you don't need to loop through the structured nodes. Only works while no sets are defined. Default: `false`.
-
name: always_show_set_button
type: boolean
description: >
Always show the "Add Set" button. Default: `false`.
-
name: remove_empty_nodes
type: string
description: >
Choose how to deal with empty nodes. Options: `false`, `true`, `trim`. Default: `false`.
id: f4bf58d3-cbce-4957-b883-d92fd4791e89
---
## Overview
Bard is our recommended fieldtype for creating long form content from the control panel. It's highly configurable, intuitive, user-friendly, and writes impeccable HTML (thanks to [ProseMirror][prosemirror]).
Bard also has the ability to manage "sets" of fields inline with your text. These sets can contain any number of other fields of any [fieldtype](/fieldtypes), and can be collapsed and neatly rearranged in your content.
## Working With Sets {#sets}
You can use any fieldtypes inside your Bard sets. Make sure to compare the experience with the other meta-fields: [Grid](/fieldtypes/grid) and [Replicator](/fieldtypes/replicator). You can even use Grids and Replicators inside your Bard sets. Just remember that because you can doesn't mean you should. Your UI experience can vary greatly.
### Set Previews
New to Statamic v6, you can add an image preview of your set, _as well as_ an icon. Previews make it easy to identify sets by showing a screenshot of what the rendered set might look like on the front-end. Clients can now say “ah, that one” without pretending to know the names you carefully gave them.
#### Configuring Set Previews
To add a set preview, click the little "pencil" icon next to the set name.
<figure>
<img src="/img/fieldtypes/screenshots/v6/bard-set-edit-preview.webp" alt="Bard Set Edit Preview" class="u-hide-in-dark-mode">
<img src="/img/fieldtypes/screenshots/v6/bard-set-edit-preview-dark.webp" alt="Bard Set Edit Preview" class="u-hide-in-light-mode">
<figcaption>Let's give the set a preview.</figcaption>
</figure>
Once you're in the set editor, you can add a preview image and icon. Here we're showing a lovely screenshot of what the newsletter signup form might look like on the front-end. We can even add some instructions to explain how the set is used.
<figure>
<img src="/img/fieldtypes/screenshots/v6/bard-set-previews.webp" alt="Bard Set Previews" class="u-hide-in-dark-mode">
<img src="/img/fieldtypes/screenshots/v6/bard-set-previews-dark.webp" alt="Bard Set Previews" class="u-hide-in-light-mode">
<figcaption>Behold a <em>Preview Image</em>, for the love of all clients.</figcaption>
</figure>
#### Set Previews in Action
Once you've set a preview image, users adding a bard set can hover over the set to preview what it might look like on the frontend.
You can view previews in two different UI modes: in a list of set names, or in a grid of sets with their preview images.
<figure>
<img src="/img/fieldtypes/screenshots/v6/bard-hover-preview-list.webp" alt="Bard Set Previews in the CP" class="u-hide-in-dark-mode">
<img src="/img/fieldtypes/screenshots/v6/bard-hover-preview-list-dark.webp" alt="Bard Set Previews in the CP" class="u-hide-in-light-mode">
<figcaption>A preview in a list of sets.</figcaption>
</figure>
<figure>
<img src="/img/fieldtypes/screenshots/v6/bard-hover-preview-grid.webp" alt="Bard Set Previews in the CP" class="u-hide-in-dark-mode">
<img src="/img/fieldtypes/screenshots/v6/bard-hover-preview-grid-dark.webp" alt="Bard Set Previews in the CP" class="u-hide-in-light-mode">
<figcaption>A preview in a grid of sets. Previews fall back to the set icon if no preview image is set.</figcaption>
</figure>
### Custom Set Icons
You can change the icons available in the set picker by configuring an icon set in a service provider.
For example, you can drop this into your `AppServiceProvider`'s `boot` method:
```php
use Statamic\Fieldtypes\Sets;
public function boot()
{
Sets::useIcons('heroicons', resource_path('svg/heroicons'));
}
```
## Data Structure
Bard stores your data as a [ProseMirror document](https://prosemirror.net/docs/ref/#model.Document_Structure). You should never need to interact with this data directly, thanks to [augmentation](/augmentation).
## Templating
### Without Sets
If you are using Bard just as a rich text editor and have no need for sets you would use a single tag to render the content.
::tabs
```antlers
{{ bard_field }}
```
::tab
```blade
{!! $bard_field !!}
```
::
### With Sets
When working with sets, you should use the tag pair syntax and `if/else` conditions on the `type` variable to style each set accordingly. **Note**: any content that is entered _not_ in a set (i.e. your normal rich-text content) needs to be rendered using the "text" type. See the first condition using "text."
::tabs
```antlers
{{ bard_field }}
{{ if type == "text" }}
<div class="text">
{{ text }}
</div>
{{ elseif type == "poll" }}
<figure class="poll">
<figcaption>{{ question }}</figcaption>
<ul>
{{ options }}
<li>{{ text }}</li>
{{ /options }}
</ul>
</figure>
{{ elseif type == "hero_image" }}
<div class="heroimage">
<img src="{{ hero_image }}" alt="{{ caption }}" />
</div>
{{ /if }}
{{ /bard_field }}
```
::tab
```blade
@foreach ($bard_field_with_sets as $set)
@if ($set->type === 'text')
<div class="text">
{!! $set->text !!}
</div>
@elseif ($set->type === 'poll')
<figure class="poll">
<figcaption>{{ $set->question }}</figcaption>
<ul>
@foreach ($set->options as $option)
<li>{{ $option->text }}</li>
@endforeach
</ul>
</figure>
@elseif ($set->type === 'hero_image' && $hero_image = $set->hero_image)
<div class="heroimage">
<img src="{{ $hero_image }}" alt="{{ $hero_image->caption }}" />
</div>
@endif
@endforeach
```
::
An alternative approach (for those who like DRY or small templates) is to create multiple "set" partials and pass the data to them dynamically, moving the markup into corresponding partials bearing the set's name.
::tabs
::tab antlers
```antlers
{{ bard_field }}
{{ partial src="sets/{type}" }}
{{ /bard_field }}
```
``` files theme:serendipity-light
resources/views/partials/sets/
gallery.antlers.html
hero_image.antlers.html
poll.antlers.html
text.antlers.html
video.antlers.html
```
::tab blade
:::tip
By using `[...$set]`, you can access the set variables within the set's Blade file without having to reference `$set` for each variable.
For example, `{!! $set->text !!}` becomes `{!! $text !!}`.
:::
```blade
@foreach ($bard_field_with_sets as $set)
@include('fieldtypes.bard.sets.'.$set->type, [...$set])
@endforeach
```
``` files theme:serendipity-light
resources/views/partials/sets/
gallery.blade.php
hero_image.blade.php
poll.blade.php
text.blade.php
video.blade.php
```
::
## Extending Bard
Bard uses [TipTap](https://tiptap.dev/) (which in turn is built on top of [ProseMirror][prosemirror]) as the foundation for our quintessential block-based editor.
[prosemirror]: https://prosemirror.net/
### Required Reading
Before you attempt to create any Bard extensions, it is wise to learn how to write a Tiptap extension first. Otherwise you'd be trying to learn how to ride a motorcycle before you can even ride a bike. Or a unicycle before you can juggle. To have a better understanding of how to write a Tiptap extension, you'd in turn benefit greatly on reading about how ProseMirror works.
:::tip
Writing custom extensions for Bard is pretty complicated, but can be rewarding and provide powerful results.
:::
In short, here's a quick-start of the things you should probably start with:
- [The ProseMirror guide](https://prosemirror.net/docs/guide/) — Yes, it's really long, but you should at least pretend to read it
- Checking out the [The Tiptap documentation](https://tiptap.dev/docs/editor/getting-started/overview) and [code samples for the core Tiptap extensions](https://github.com/ueberdosis/tiptap/tree/develop/packages), so you can understand how Tiptap relates to ProseMirror
- If you don't know [how to extend the control panel](/control-panel/css-javascript) yet, go ahead and read up on that first. The code snippets later will be part of your extension to the control panel. Alternatively, you may also [extend the control panel through the creation of an addon](/addons/building-an-addon).
- Come back here again and keep on going.
### Adding New Extensions
You may add your own Tiptap extensions to Bard using the `addExtension` method. The callback may return a single extension, or an array of them.
``` js
const { Node, Mark, Extension } = Statamic.$bard.tiptap.core;
Statamic.$bard.addExtension(() => Node.create({...}));
```
``` js
Statamic.$bard.addExtension(() => {
return [
Node.create({...}),
Mark.create({...}),
Extension.create({...}),
]
});
```
Check out [Tiptap's custom extension documentation](https://tiptap.dev/docs/editor/extensions/custom-extensions) and [code samples for the core Tiptap extensions](https://github.com/ueberdosis/tiptap/tree/develop/packages) to find out how to write an ex
gitextract_4rmyxzvf/ ├── .editorconfig ├── .gitattributes ├── .github/ │ └── FUNDING.yml ├── .gitignore ├── .nvmrc ├── LICENSE.md ├── README.md ├── app/ │ ├── Http/ │ │ ├── Controllers/ │ │ │ ├── Controller.php │ │ │ ├── DocsMarkdownController.php │ │ │ └── LlmsTxtController.php │ │ └── Middleware/ │ │ └── CheckForMaintenanceMode.php │ ├── Markdown/ │ │ ├── Hint/ │ │ │ ├── Hint.php │ │ │ ├── HintExtension.php │ │ │ ├── HintParser.php │ │ │ ├── HintRenderer.php │ │ │ └── HintStartParser.php │ │ └── Tabs/ │ │ ├── TabbedCodeBlock.php │ │ ├── TabbedCodeBlockExtension.php │ │ ├── TabbedCodeStartParser.php │ │ ├── TabsParser.php │ │ └── TabsRenderer.php │ ├── Models/ │ │ └── User.php │ ├── Modifiers/ │ │ ├── Split.php │ │ └── Toc.php │ ├── Providers/ │ │ └── AppServiceProvider.php │ ├── Search/ │ │ ├── DocTransformer.php │ │ ├── Listeners/ │ │ │ └── SearchEntriesCreatedListener.php │ │ ├── RequestContentRetriever.php │ │ └── Storybook/ │ │ ├── StorybookSearchProvider.php │ │ └── StorybookSearchable.php │ ├── Tags/ │ │ ├── GithubCommitsUrl.php │ │ ├── GithubEditUrl.php │ │ └── HeroSponsors.php │ └── ViewModels/ │ ├── Fieldtypes.php │ ├── Modifiers.php │ ├── Tags.php │ └── Variables.php ├── artisan ├── bootstrap/ │ ├── app.php │ ├── cache/ │ │ └── .gitignore │ └── providers.php ├── composer.json ├── config/ │ ├── app.php │ ├── auth.php │ ├── cache.php │ ├── database.php │ ├── docs.php │ ├── filesystems.php │ ├── logging.php │ ├── mail.php │ ├── queue.php │ ├── services.php │ ├── session.php │ ├── statamic/ │ │ ├── antlers.php │ │ ├── api.php │ │ ├── assets.php │ │ ├── autosave.php │ │ ├── cp.php │ │ ├── editions.php │ │ ├── forms.php │ │ ├── git.php │ │ ├── graphql.php │ │ ├── live_preview.php │ │ ├── markdown.php │ │ ├── oauth.php │ │ ├── protect.php │ │ ├── revisions.php │ │ ├── routes.php │ │ ├── search.php │ │ ├── stache.php │ │ ├── static_caching.php │ │ ├── system.php │ │ ├── templates.php │ │ ├── users.php │ │ └── webauthn.php │ └── torchlight.php ├── content/ │ ├── assets/ │ │ ├── .gitkeep │ │ └── main.yaml │ ├── collections/ │ │ ├── .gitkeep │ │ ├── fieldtypes/ │ │ │ ├── array.md │ │ │ ├── assets.md │ │ │ ├── bard.md │ │ │ ├── button_group.md │ │ │ ├── checkboxes.md │ │ │ ├── code.md │ │ │ ├── collections.md │ │ │ ├── color.md │ │ │ ├── date.md │ │ │ ├── dictionary.md │ │ │ ├── entries.md │ │ │ ├── float.md │ │ │ ├── form.md │ │ │ ├── grid.md │ │ │ ├── group.md │ │ │ ├── hidden.md │ │ │ ├── html.md │ │ │ ├── icon.md │ │ │ ├── integer.md │ │ │ ├── link.md │ │ │ ├── list.md │ │ │ ├── markdown.md │ │ │ ├── navs.md │ │ │ ├── radio.md │ │ │ ├── range.md │ │ │ ├── replicator.md │ │ │ ├── revealer.md │ │ │ ├── select.md │ │ │ ├── sites.md │ │ │ ├── slug.md │ │ │ ├── spacer.md │ │ │ ├── structures.md │ │ │ ├── table.md │ │ │ ├── taggable.md │ │ │ ├── taxonomies.md │ │ │ ├── template.md │ │ │ ├── terms.md │ │ │ ├── text.md │ │ │ ├── textarea.md │ │ │ ├── time.md │ │ │ ├── toggle.md │ │ │ ├── user-groups.md │ │ │ ├── user-roles.md │ │ │ ├── users.md │ │ │ ├── video.md │ │ │ ├── width.md │ │ │ └── yaml.md │ │ ├── fieldtypes.yaml │ │ ├── modifiers/ │ │ │ ├── add.md │ │ │ ├── add_slashes.md │ │ │ ├── ampersand_list.md │ │ │ ├── antlers.md │ │ │ ├── as.md │ │ │ ├── ascii.md │ │ │ ├── at.md │ │ │ ├── attribute.md │ │ │ ├── background_position.md │ │ │ ├── backspace.md │ │ │ ├── bard_html.md │ │ │ ├── bard_items.md │ │ │ ├── bard_text.md │ │ │ ├── bool_string.md │ │ │ ├── camelize.md │ │ │ ├── cdata.md │ │ │ ├── ceil.md │ │ │ ├── chunk.md │ │ │ ├── classes.md │ │ │ ├── collapse.md │ │ │ ├── collapse_whitespace.md │ │ │ ├── compact.md │ │ │ ├── console_log.md │ │ │ ├── contains.md │ │ │ ├── contains_all.md │ │ │ ├── contains_any.md │ │ │ ├── count.md │ │ │ ├── count_substring.md │ │ │ ├── dashify.md │ │ │ ├── days_ago.md │ │ │ ├── decode.md │ │ │ ├── deslugify.md │ │ │ ├── divide.md │ │ │ ├── dl.md │ │ │ ├── doesnt_overlap.md │ │ │ ├── dump.md │ │ │ ├── embed_url.md │ │ │ ├── ends_with.md │ │ │ ├── ensure_left.md │ │ │ ├── ensure_right.md │ │ │ ├── entities.md │ │ │ ├── excerpt.md │ │ │ ├── explode.md │ │ │ ├── favicon.md │ │ │ ├── filter_empty.md │ │ │ ├── first.md │ │ │ ├── flatten.md │ │ │ ├── flip.md │ │ │ ├── floor.md │ │ │ ├── folder.yaml │ │ │ ├── format.md │ │ │ ├── format_number.md │ │ │ ├── format_translated.md │ │ │ ├── full_urls.md │ │ │ ├── get.md │ │ │ ├── gravatar.md │ │ │ ├── group_by.md │ │ │ ├── has_lower_case.md │ │ │ ├── has_upper_case.md │ │ │ ├── headline.md │ │ │ ├── hex_to_rgb.md │ │ │ ├── hours_ago.md │ │ │ ├── image.md │ │ │ ├── in_array.md │ │ │ ├── insert.md │ │ │ ├── is_after.md │ │ │ ├── is_alpha.md │ │ │ ├── is_alphanumeric.md │ │ │ ├── is_array.md │ │ │ ├── is_before.md │ │ │ ├── is_between.md │ │ │ ├── is_blank.md │ │ │ ├── is_email.md │ │ │ ├── is_embeddable.md │ │ │ ├── is_empty.md │ │ │ ├── is_external_url.md │ │ │ ├── is_future.md │ │ │ ├── is_json.md │ │ │ ├── is_leap_year.md │ │ │ ├── is_lowercase.md │ │ │ ├── is_numberwang.md │ │ │ ├── is_numeric.md │ │ │ ├── is_past.md │ │ │ ├── is_today.md │ │ │ ├── is_tomorrow.md │ │ │ ├── is_uppercase.md │ │ │ ├── is_url.md │ │ │ ├── is_weekday.md │ │ │ ├── is_weekend.md │ │ │ ├── is_yesterday.md │ │ │ ├── iso_format.md │ │ │ ├── join.md │ │ │ ├── kebab.md │ │ │ ├── key_by.md │ │ │ ├── keys.md │ │ │ ├── last.md │ │ │ ├── lcfirst.md │ │ │ ├── length.md │ │ │ ├── limit.md │ │ │ ├── link.md │ │ │ ├── list.md │ │ │ ├── lower.md │ │ │ ├── macro.md │ │ │ ├── mailto.md │ │ │ ├── mark.md │ │ │ ├── markdown.md │ │ │ ├── md5.md │ │ │ ├── merge.md │ │ │ ├── minutes_ago.md │ │ │ ├── mod.md │ │ │ ├── modify_date.md │ │ │ ├── months_ago.md │ │ │ ├── multiply.md │ │ │ ├── nl2br.md │ │ │ ├── obfuscate.md │ │ │ ├── obfuscate_email.md │ │ │ ├── offset.md │ │ │ ├── ol.md │ │ │ ├── option_list.md │ │ │ ├── output.md │ │ │ ├── overlaps.md │ │ │ ├── pad.md │ │ │ ├── parse_url.md │ │ │ ├── partial.md │ │ │ ├── pathinfo.md │ │ │ ├── piped.md │ │ │ ├── pluck.md │ │ │ ├── plural.md │ │ │ ├── random.md │ │ │ ├── raw.md │ │ │ ├── rawurlencode.md │ │ │ ├── rawurlencode_except_slashes.md │ │ │ ├── ray.md │ │ │ ├── read_time.md │ │ │ ├── regex_mark.md │ │ │ ├── regex_replace.md │ │ │ ├── relative.md │ │ │ ├── remove_left.md │ │ │ ├── remove_right.md │ │ │ ├── repeat.md │ │ │ ├── replace.md │ │ │ ├── resolve.md │ │ │ ├── reverse.md │ │ │ ├── round.md │ │ │ ├── safe_truncate.md │ │ │ ├── sanitize.md │ │ │ ├── scope.md │ │ │ ├── seconds_ago.md │ │ │ ├── segment.md │ │ │ ├── select.md │ │ │ ├── sentence_list.md │ │ │ ├── shuffle.md │ │ │ ├── singular.md │ │ │ ├── slugify.md │ │ │ ├── smartypants.md │ │ │ ├── snake.md │ │ │ ├── sort.md │ │ │ ├── spaceless.md │ │ │ ├── split.md │ │ │ ├── starts_with.md │ │ │ ├── str_pad_left.md │ │ │ ├── strip_tags.md │ │ │ ├── studly.md │ │ │ ├── substr.md │ │ │ ├── subtract.md │ │ │ ├── sum.md │ │ │ ├── surround.md │ │ │ ├── swap_case.md │ │ │ ├── table.md │ │ │ ├── tidy.md │ │ │ ├── timezone.md │ │ │ ├── title.md │ │ │ ├── to_json.md │ │ │ ├── to_qs.md │ │ │ ├── to_spaces.md │ │ │ ├── to_tabs.md │ │ │ ├── trans.md │ │ │ ├── trim.md │ │ │ ├── truncate.md │ │ │ ├── ucfirst.md │ │ │ ├── ul.md │ │ │ ├── underscored.md │ │ │ ├── unique.md │ │ │ ├── upper.md │ │ │ ├── url.md │ │ │ ├── urldecode.md │ │ │ ├── urlencode.md │ │ │ ├── urlencode_except_slashes.md │ │ │ ├── values.md │ │ │ ├── weeks_ago.md │ │ │ ├── where-in.md │ │ │ ├── where.md │ │ │ ├── widont.md │ │ │ ├── word_count.md │ │ │ ├── wrap.md │ │ │ └── years_ago.md │ │ ├── modifiers.yaml │ │ ├── pages/ │ │ │ ├── 3-0-to-3-1.md │ │ │ ├── 3-1-to-3-2.md │ │ │ ├── 3-2-to-3-3.md │ │ │ ├── 3-3-to-3-4.md │ │ │ ├── 3-4-to-4-0.md │ │ │ ├── 4-to-5.md │ │ │ ├── 5-to-6.md │ │ │ ├── actions.md │ │ │ ├── addons.md │ │ │ ├── advanced-topics.md │ │ │ ├── all-fieldtypes.md │ │ │ ├── all-modifiers.md │ │ │ ├── all-tags.md │ │ │ ├── all-variables.md │ │ │ ├── all-widgets.md │ │ │ ├── antlers.md │ │ │ ├── assets.md │ │ │ ├── augmentation.md │ │ │ ├── backend-apis.md │ │ │ ├── bard-v1-to-v2.md │ │ │ ├── blade-form-fields.md │ │ │ ├── blade.md │ │ │ ├── blink-cache.md │ │ │ ├── blueprints.md │ │ │ ├── build-a-fieldtype.md │ │ │ ├── building-a-tag.md │ │ │ ├── building-a-widget.md │ │ │ ├── building-an-addon.md │ │ │ ├── caching.md │ │ │ ├── cli.md │ │ │ ├── code-of-conduct.md │ │ │ ├── collections.md │ │ │ ├── command-palette.md │ │ │ ├── computed-values.md │ │ │ ├── conditional-fields.md │ │ │ ├── conditions.md │ │ │ ├── configuration.md │ │ │ ├── content-managers-guide.md │ │ │ ├── content-modeling.md │ │ │ ├── content-queries.md │ │ │ ├── contributing.md │ │ │ ├── contribution-guide.md │ │ │ ├── control-panel.md │ │ │ ├── controllers.md │ │ │ ├── core-concepts.md │ │ │ ├── cp-navigation.md │ │ │ ├── cp-translations.md │ │ │ ├── creating-a-starter-kit.md │ │ │ ├── css-javascript.md │ │ │ ├── customizing-the-cp-nav.md │ │ │ ├── dashboard.md │ │ │ ├── data-inheritance.md │ │ │ ├── data.md │ │ │ ├── debugging.md │ │ │ ├── deploying.md │ │ │ ├── dictionaries.md │ │ │ ├── digital-ocean.md │ │ │ ├── digitalocean.md │ │ │ ├── dirty-state-tracking.md │ │ │ ├── docker.md │ │ │ ├── elevated-sessions.md │ │ │ ├── email.md │ │ │ ├── events.md │ │ │ ├── field-actions.md │ │ │ ├── fields.md │ │ │ ├── fieldsets.md │ │ │ ├── fieldtypes.1.md │ │ │ ├── formatters.md │ │ │ ├── forms.md │ │ │ ├── fortrabbit.md │ │ │ ├── from-wordpress-to-statamic.md │ │ │ ├── frontend.md │ │ │ ├── getting-started.md │ │ │ ├── git-automation.md │ │ │ ├── globals.md │ │ │ ├── graphql.md │ │ │ ├── home.md │ │ │ ├── hooks.md │ │ │ ├── image-manipulation.md │ │ │ ├── installing-a-starter-kit.md │ │ │ ├── installing.md │ │ │ ├── javascript-frameworks.md │ │ │ ├── js-events.md │ │ │ ├── js-hooks.md │ │ │ ├── keyboard-shortcuts.md │ │ │ ├── knowledge-base.md │ │ │ ├── laravel-7-to-8.md │ │ │ ├── laravel-cloud.md │ │ │ ├── laravel-forge-1-click.md │ │ │ ├── laravel-forge.md │ │ │ ├── laravel-herd.md │ │ │ ├── laravel.md │ │ │ ├── licensing.md │ │ │ ├── lifecycle.md │ │ │ ├── linode.md │ │ │ ├── live-preview.md │ │ │ ├── local.md │ │ │ ├── markdown.md │ │ │ ├── modifiers.1.md │ │ │ ├── modifiers.md │ │ │ ├── multi-site.md │ │ │ ├── multi-user-collaboration.md │ │ │ ├── navigation.md │ │ │ ├── netlify.md │ │ │ ├── oauth.md │ │ │ ├── overview.1.md │ │ │ ├── overview.10.md │ │ │ ├── overview.12.md │ │ │ ├── overview.2.md │ │ │ ├── overview.3.md │ │ │ ├── overview.4.md │ │ │ ├── overview.5.md │ │ │ ├── overview.6.md │ │ │ ├── overview.7.md │ │ │ ├── overview.8.md │ │ │ ├── overview.md │ │ │ ├── permissions.md │ │ │ ├── ploi.md │ │ │ ├── preferences.md │ │ │ ├── progress.md │ │ │ ├── protecting-content.md │ │ │ ├── publish-forms.md │ │ │ ├── query-scopes-and-filters.md │ │ │ ├── quick-start-guide.md │ │ │ ├── relationship-fieldtypes.md │ │ │ ├── relationships.md │ │ │ ├── release-schedule-support-policy.md │ │ │ ├── repositories.md │ │ │ ├── requirements.md │ │ │ ├── resource-apis.md │ │ │ ├── rest-api.md │ │ │ ├── revisions.md │ │ │ ├── routing.1.md │ │ │ ├── routing.md │ │ │ ├── scheduling.md │ │ │ ├── search.md │ │ │ ├── sites-api.md │ │ │ ├── slugs.md │ │ │ ├── stache.md │ │ │ ├── starter-kits.md │ │ │ ├── static-caching.md │ │ │ ├── structures.md │ │ │ ├── tags.md │ │ │ ├── taxonomies.md │ │ │ ├── testing.md │ │ │ ├── tips.md │ │ │ ├── toast-notifications.md │ │ │ ├── troubleshooting.md │ │ │ ├── ubuntu.md │ │ │ ├── ui-components.md │ │ │ ├── updating-a-starter-kit.md │ │ │ ├── updating.md │ │ │ ├── upgrade-guide.md │ │ │ ├── users.md │ │ │ ├── utilities.md │ │ │ ├── v2-to-v3.md │ │ │ ├── validation.md │ │ │ ├── variables.md │ │ │ ├── vercel.md │ │ │ ├── view-models.md │ │ │ ├── views.md │ │ │ ├── vite-tooling.md │ │ │ ├── vue-2-to-3.md │ │ │ ├── vue-components.md │ │ │ ├── white-labeling.md │ │ │ ├── widgets.md │ │ │ └── yaml.md │ │ ├── pages.yaml │ │ ├── resource_apis/ │ │ │ ├── asset-container-repository.md │ │ │ ├── asset-repository.md │ │ │ ├── collection-repository.md │ │ │ ├── entry-repository.md │ │ │ ├── form-repository.md │ │ │ ├── form-submission-repository.md │ │ │ ├── global-repository.md │ │ │ ├── site-repository.md │ │ │ ├── taxonomy-repository.md │ │ │ ├── term-repository.md │ │ │ ├── user-group-repository.md │ │ │ ├── user-repository.md │ │ │ └── user-role-repository.md │ │ ├── resource_apis.yaml │ │ ├── tags/ │ │ │ ├── 404.md │ │ │ ├── asset.md │ │ │ ├── assets.md │ │ │ ├── cache.md │ │ │ ├── children.md │ │ │ ├── collection-count.md │ │ │ ├── collection-next.md │ │ │ ├── collection-previous.md │ │ │ ├── collection.md │ │ │ ├── cookie.md │ │ │ ├── dictionary.md │ │ │ ├── dump.md │ │ │ ├── foreach.md │ │ │ ├── form-create.md │ │ │ ├── form-errors.md │ │ │ ├── form-fields.md │ │ │ ├── form-set.md │ │ │ ├── form-submission.md │ │ │ ├── form-submissions.md │ │ │ ├── form-success.md │ │ │ ├── form.md │ │ │ ├── get_content.md │ │ │ ├── get_error.md │ │ │ ├── get_errors.md │ │ │ ├── get_files.md │ │ │ ├── get_site.md │ │ │ ├── glide-batch.md │ │ │ ├── glide-data-url.md │ │ │ ├── glide.md │ │ │ ├── increment.md │ │ │ ├── installed.md │ │ │ ├── link.md │ │ │ ├── locales-count.md │ │ │ ├── locales.md │ │ │ ├── loop.md │ │ │ ├── markdown-indent.md │ │ │ ├── markdown.md │ │ │ ├── mix.md │ │ │ ├── mount_url.md │ │ │ ├── nav-breadcrumbs.md │ │ │ ├── nav.md │ │ │ ├── nocache.md │ │ │ ├── oauth.md │ │ │ ├── obfuscate.md │ │ │ ├── parent.md │ │ │ ├── partial-exists.md │ │ │ ├── partial-if-exists.md │ │ │ ├── partial.md │ │ │ ├── protect-password_form.md │ │ │ ├── redirect.md │ │ │ ├── route.md │ │ │ ├── scope.md │ │ │ ├── search.md │ │ │ ├── section.md │ │ │ ├── session-dump.md │ │ │ ├── session-flash.md │ │ │ ├── session-flush.md │ │ │ ├── session-forget.md │ │ │ ├── session-has.md │ │ │ ├── session-set.md │ │ │ ├── session.md │ │ │ ├── svg.md │ │ │ ├── switch.md │ │ │ ├── taxonomy-count.md │ │ │ ├── taxonomy.md │ │ │ ├── trans.md │ │ │ ├── user-can.md │ │ │ ├── user-delete_passkey_form.md │ │ │ ├── user-disable_two_factor_form.md │ │ │ ├── user-elevated_session_form.md │ │ │ ├── user-forgot_password_form.md │ │ │ ├── user-groups.md │ │ │ ├── user-in.md │ │ │ ├── user-is.md │ │ │ ├── user-login_form.md │ │ │ ├── user-logout.md │ │ │ ├── user-logout_url.md │ │ │ ├── user-passkey_form.md │ │ │ ├── user-passkeys.md │ │ │ ├── user-password_form.md │ │ │ ├── user-profile.md │ │ │ ├── user-profile_form.md │ │ │ ├── user-register_form.md │ │ │ ├── user-reset_password_form.md │ │ │ ├── user-reset_two_factor_recovery_codes_form.md │ │ │ ├── user-roles.md │ │ │ ├── user-two_factor_challenge_form.md │ │ │ ├── user-two_factor_enable_form.md │ │ │ ├── user-two_factor_enabled.md │ │ │ ├── user-two_factor_recovery_codes.md │ │ │ ├── user-two_factor_recovery_codes_download_url.md │ │ │ ├── user-two_factor_setup_form.md │ │ │ ├── users.md │ │ │ ├── vite-content.md │ │ │ ├── vite.md │ │ │ └── yield.md │ │ ├── tags.yaml │ │ ├── tips/ │ │ │ ├── building-your-own-entries-repository.md │ │ │ ├── change-timezone-to-utc.md │ │ │ ├── configuring-update-scripts.md │ │ │ ├── content-security-policy.md │ │ │ ├── converting-from-single-to-multi-site.md │ │ │ ├── creating-users-by-hand.md │ │ │ ├── digital-ocean-spaces-for-asset-container.md │ │ │ ├── disabling-cp-authentication.md │ │ │ ├── excluding-the-control-panel-from-maintenance-mode.md │ │ │ ├── gdpr-considerations.md │ │ │ ├── git-workflow.md │ │ │ ├── how-to-enable-statamic-pro.md │ │ │ ├── importing-content.md │ │ │ ├── laravel-nova.md │ │ │ ├── load-templates-dynamically-based-on-the-url.md │ │ │ ├── localizing-entries.md │ │ │ ├── localizing-globals.md │ │ │ ├── localizing-navigation.md │ │ │ ├── manually-resetting-a-user-password.md │ │ │ ├── optimizing-assets.md │ │ │ ├── overriding-exception-rendering.md │ │ │ ├── pushing-related-entries-to-an-algolia-index.md │ │ │ ├── recursive-nav-examples.md │ │ │ ├── reserved-words.md │ │ │ ├── setting-default-listing-columns.md │ │ │ ├── storing-content-in-a-database.md │ │ │ ├── storing-laravel-users-in-files.md │ │ │ ├── storing-users-in-a-database.md │ │ │ ├── storing-users-somewhere-custom.md │ │ │ ├── taxonomies-by-hand.md │ │ │ ├── timezones.md │ │ │ ├── trailing-slashes.md │ │ │ ├── using-an-independent-authentication-guard.md │ │ │ ├── using-statamic-with-laravel-nightwatch.md │ │ │ └── zero-downtime-deployments.md │ │ ├── tips.yaml │ │ ├── troubleshooting/ │ │ │ ├── asset-permissions.md │ │ │ ├── assets-missing-urls.md │ │ │ ├── command-not-found-statamic.md │ │ │ ├── composer-and-github-authentication.md │ │ │ ├── control-panel-page-expired.md │ │ │ ├── email-not-sending.md │ │ │ ├── fixing-issues-with-global-composer-packages.md │ │ │ ├── listing-performance.md │ │ │ ├── missing-control-panel-assets.md │ │ │ └── required-php-extensions.md │ │ ├── troubleshooting.yaml │ │ ├── variables/ │ │ │ ├── basename.md │ │ │ ├── collection.md │ │ │ ├── config.md │ │ │ ├── csrf_field.md │ │ │ ├── csrf_token.md │ │ │ ├── current_layout.md │ │ │ ├── current_template.md │ │ │ ├── current_uri.md │ │ │ ├── current_url.md │ │ │ ├── current_user.md │ │ │ ├── date.md │ │ │ ├── datestamp.md │ │ │ ├── datestring.md │ │ │ ├── edit_url.md │ │ │ ├── entries_count.md │ │ │ ├── environment.md │ │ │ ├── extension.md │ │ │ ├── filename.md │ │ │ ├── focus.md │ │ │ ├── focus_css.md │ │ │ ├── folder.yaml │ │ │ ├── get.md │ │ │ ├── get_post.md │ │ │ ├── has_timestamp.md │ │ │ ├── height.md │ │ │ ├── homepage.md │ │ │ ├── id.md │ │ │ ├── is_asset.md │ │ │ ├── is_entry.md │ │ │ ├── is_homepage.md │ │ │ ├── is_image.md │ │ │ ├── is_term.md │ │ │ ├── is_video.md │ │ │ ├── last_modified.md │ │ │ ├── last_segment.md │ │ │ ├── live_preview.md │ │ │ ├── logged_in.md │ │ │ ├── now.md │ │ │ ├── old.md │ │ │ ├── order.md │ │ │ ├── order_type.md │ │ │ ├── path.md │ │ │ ├── permalink.md │ │ │ ├── post.md │ │ │ ├── published.md │ │ │ ├── response_code.md │ │ │ ├── segment_x.md │ │ │ ├── site.md │ │ │ ├── sites.md │ │ │ ├── size.md │ │ │ ├── size_bytes.md │ │ │ ├── size_gigabytes.md │ │ │ ├── size_kilobytes.md │ │ │ ├── size_megabytes.md │ │ │ ├── slug.md │ │ │ ├── taxonomy.md │ │ │ ├── timestamp.md │ │ │ ├── url.md │ │ │ ├── width.md │ │ │ └── xml_header.md │ │ ├── variables.yaml │ │ ├── widgets/ │ │ │ ├── collection.md │ │ │ ├── form.md │ │ │ └── updater.md │ │ └── widgets.yaml │ ├── globals/ │ │ ├── .gitkeep │ │ ├── default/ │ │ │ └── global.yaml │ │ └── global.yaml │ ├── navigation/ │ │ └── .gitkeep │ ├── structures/ │ │ └── .gitkeep │ ├── taxonomies/ │ │ ├── .gitkeep │ │ ├── categories/ │ │ │ ├── cli.yaml │ │ │ ├── database.yaml │ │ │ ├── development.yaml │ │ │ ├── devops.yaml │ │ │ ├── laravel.yaml │ │ │ ├── localization.yaml │ │ │ ├── performance.yaml │ │ │ ├── privacy-gdpr.yaml │ │ │ └── troubleshooting.yaml │ │ ├── categories.yaml │ │ ├── modifier_types.yaml │ │ ├── tags/ │ │ │ └── beginner.yaml │ │ ├── tags.yaml │ │ ├── types/ │ │ │ ├── asset.yaml │ │ │ ├── content.yaml │ │ │ ├── entry.yaml │ │ │ ├── system.yaml │ │ │ └── term.yaml │ │ └── types.yaml │ └── trees/ │ ├── collections/ │ │ └── pages.yaml │ └── navigation/ │ ├── docs.yaml │ ├── extending_docs.yaml │ ├── guides.yaml │ ├── reference.yaml │ ├── screencasts.yaml │ ├── sections.yaml │ └── top.yaml ├── database/ │ ├── .gitignore │ ├── factories/ │ │ └── UserFactory.php │ ├── migrations/ │ │ ├── 0001_01_01_000000_create_users_table.php │ │ ├── 0001_01_01_000001_create_cache_table.php │ │ └── 0001_01_01_000002_create_jobs_table.php │ └── seeders/ │ └── DatabaseSeeder.php ├── lang/ │ └── en/ │ └── validation.php ├── package.json ├── phpunit.xml ├── please ├── postcss.config.js ├── public/ │ ├── .htaccess │ ├── favicons/ │ │ └── site.webmanifest │ ├── img/ │ │ ├── adverts/ │ │ │ └── .gitkeep │ │ ├── navigation/ │ │ │ └── .gitkeep │ │ ├── pro-badges/ │ │ │ ├── .gitkeep │ │ │ ├── artwork/ │ │ │ │ └── .gitkeep │ │ │ └── icons/ │ │ │ └── .gitkeep │ │ └── tiles/ │ │ └── .gitkeep │ ├── index.php │ ├── mix-manifest.json │ └── robots.txt ├── resources/ │ ├── blueprints/ │ │ ├── collections/ │ │ │ ├── adverts/ │ │ │ │ └── advert.yaml │ │ │ ├── extending-docs/ │ │ │ │ └── page.yaml │ │ │ ├── fieldtypes/ │ │ │ │ └── fieldtype.yaml │ │ │ ├── guides/ │ │ │ │ └── guides.yaml │ │ │ ├── knowledge-base/ │ │ │ │ └── page.yaml │ │ │ ├── modifiers/ │ │ │ │ └── modifiers.yaml │ │ │ ├── pages/ │ │ │ │ ├── home.yaml │ │ │ │ ├── link.yaml │ │ │ │ └── page.yaml │ │ │ ├── reference/ │ │ │ │ └── reference.yaml │ │ │ ├── references/ │ │ │ │ └── references.yaml │ │ │ ├── resource_apis/ │ │ │ │ └── resource_apis.yaml │ │ │ ├── screencasts/ │ │ │ │ └── screencasts.yaml │ │ │ ├── sections/ │ │ │ │ └── sections.yaml │ │ │ ├── tags/ │ │ │ │ ├── tag-glide.yaml │ │ │ │ └── tag.yaml │ │ │ ├── tips/ │ │ │ │ └── tips.yaml │ │ │ ├── troubleshooting/ │ │ │ │ └── troubleshooting.yaml │ │ │ ├── ui_components/ │ │ │ │ └── ui_component.yaml │ │ │ ├── variables/ │ │ │ │ └── variables.yaml │ │ │ └── widgets/ │ │ │ └── widgets.yaml │ │ ├── globals/ │ │ │ └── global.yaml │ │ ├── navigation/ │ │ │ ├── docs.yaml │ │ │ ├── extending_docs.yaml │ │ │ └── reference.yaml │ │ └── taxonomies/ │ │ └── categories/ │ │ └── categories.yaml │ ├── css/ │ │ ├── -template.css │ │ ├── README.css │ │ ├── base/ │ │ │ ├── cp.css │ │ │ ├── elements/ │ │ │ │ ├── elements.css │ │ │ │ └── tables.css │ │ │ ├── reset.css │ │ │ └── variables.css │ │ ├── components/ │ │ │ ├── anchors.css │ │ │ ├── buttons.css │ │ │ ├── doc-tabs.css │ │ │ ├── docs-header.css │ │ │ ├── entry-content.css │ │ │ ├── feedback-meerkat.css │ │ │ ├── icon-grid.css │ │ │ ├── imagery/ │ │ │ │ ├── bordered-image.css │ │ │ │ └── full-width-image.css │ │ │ ├── list-turtles.css │ │ │ ├── logos.css │ │ │ ├── nav/ │ │ │ │ ├── back-nav.css │ │ │ │ ├── breadcrumbs.css │ │ │ │ ├── sidebar-advert.css │ │ │ │ ├── sidebar.css │ │ │ │ └── toc.css │ │ │ ├── panel-list.css │ │ │ ├── pill-with-description.css │ │ │ ├── pill.css │ │ │ ├── pro-badge.css │ │ │ ├── promo.css │ │ │ ├── quirky.css │ │ │ ├── related.css │ │ │ ├── search-form.css │ │ │ ├── site-footer.css │ │ │ ├── skip-to-content.css │ │ │ ├── syntax-explainer.css │ │ │ ├── theme-picker.css │ │ │ ├── tiles-with-description.css │ │ │ ├── tip.css │ │ │ ├── version-selector.css │ │ │ └── video.css │ │ ├── objects/ │ │ │ ├── badge-heading.css │ │ │ ├── collapsible-side-menu-with-checkboxes.css │ │ │ ├── entry-content.css │ │ │ ├── scroll-shadows.css │ │ │ └── toc-scroll-spy.css │ │ ├── style.css │ │ ├── torchlight.css │ │ └── utilities/ │ │ ├── animation-keyframes.css │ │ ├── hiders.css │ │ ├── label.css │ │ └── utilities.css │ ├── fieldsets/ │ │ ├── advert_override.yaml │ │ ├── common.yaml │ │ ├── hue_rotate.yaml │ │ ├── navigation.yaml │ │ └── page.yaml │ ├── js/ │ │ ├── anchors.js │ │ ├── color-scheme-preferences.js │ │ ├── cookies.js │ │ ├── dayjs.js │ │ ├── dl.js │ │ ├── docsearch.js │ │ ├── external-links.js │ │ ├── language-badges.js │ │ ├── site.js │ │ ├── tables.js │ │ ├── toc-navigation.js │ │ └── torchlight.js │ ├── sites.yaml │ ├── users/ │ │ ├── groups.yaml │ │ └── roles.yaml │ └── views/ │ ├── default.antlers.html │ ├── deploying.antlers.html │ ├── documentation-search/ │ │ ├── docs/ │ │ │ └── page.antlers.html │ │ ├── extending-docs/ │ │ │ └── page.antlers.html │ │ ├── fieldtypes/ │ │ │ └── fieldtype.antlers.html │ │ ├── modifiers/ │ │ │ └── modifiers.antlers.html │ │ ├── reference/ │ │ │ └── reference.antlers.html │ │ ├── repositories/ │ │ │ └── repositories.antlers.html │ │ ├── screencasts/ │ │ │ └── screencasts.antlers.html │ │ ├── sections/ │ │ │ └── sections.antlers.html │ │ ├── tags/ │ │ │ ├── tag-glide.antlers.html │ │ │ └── tag.antlers.html │ │ ├── tips/ │ │ │ └── tips.antlers.html │ │ ├── troubleshooting/ │ │ │ └── troubleshooting.antlers.html │ │ ├── variables/ │ │ │ └── variables.antlers.html │ │ └── widgets/ │ │ └── widgets.antlers.html │ ├── errors/ │ │ └── 404.antlers.html │ ├── extending/ │ │ └── index.antlers.html │ ├── fieldtypes/ │ │ └── index.antlers.html │ ├── home.antlers.html │ ├── image_dimensions/ │ │ ├── navigation_image.antlers.html │ │ └── tile.antlers.html │ ├── installing.antlers.html │ ├── layout.antlers.html │ ├── listing.antlers.html │ ├── modifiers/ │ │ └── index.antlers.html │ ├── page.antlers.html │ ├── partials/ │ │ ├── details.antlers.html │ │ ├── edit.antlers.html │ │ ├── favicons.antlers.html │ │ ├── footer.antlers.html │ │ ├── head.antlers.html │ │ ├── header.antlers.html │ │ ├── lorem.antlers.html │ │ ├── meta.antlers.html │ │ ├── nav_contents.antlers.html │ │ ├── nav_sidebar.antlers.html │ │ ├── promo.antlers.html │ │ ├── related.antlers.html │ │ ├── scripts.antlers.html │ │ ├── sidebar-promo.antlers.html │ │ ├── site_header.antlers.html │ │ ├── suggest.antlers.html │ │ └── variables.antlers.html │ ├── reference/ │ │ └── index.antlers.html │ ├── repositories/ │ │ └── index.antlers.html │ ├── search.antlers.html │ ├── sitemap.antlers.html │ ├── social.antlers.html │ ├── tabs.antlers.html │ ├── tags/ │ │ ├── glide.antlers.html │ │ └── index.antlers.html │ ├── tips/ │ │ └── index.antlers.html │ ├── troubleshooting/ │ │ └── index.antlers.html │ ├── updates.antlers.html │ └── variables/ │ └── index.antlers.html ├── routes/ │ ├── console.php │ ├── redirects.php │ └── web.php ├── server.php ├── storage/ │ ├── app/ │ │ └── .gitignore │ ├── framework/ │ │ ├── .gitignore │ │ ├── cache/ │ │ │ └── .gitignore │ │ ├── sessions/ │ │ │ └── .gitignore │ │ ├── testing/ │ │ │ └── .gitignore │ │ └── views/ │ │ └── .gitignore │ ├── logs/ │ │ └── .gitignore │ └── statamic/ │ └── .gitignore ├── tests/ │ ├── CreatesApplication.php │ ├── Feature/ │ │ └── ExampleTest.php │ ├── TestCase.php │ └── Unit/ │ └── ExampleTest.php └── vite.config.js
SYMBOL INDEX (118 symbols across 42 files)
FILE: app/Http/Controllers/Controller.php
class Controller (line 10) | class Controller extends BaseController
FILE: app/Http/Controllers/DocsMarkdownController.php
class DocsMarkdownController (line 9) | class DocsMarkdownController extends Controller
method __invoke (line 11) | public function __invoke(string $uri)
method appendMdExtensionToInternalLinks (line 32) | private function appendMdExtensionToInternalLinks(string $markdown): s...
method shouldAppendMdExtension (line 50) | private function shouldAppendMdExtension(string $url): bool
FILE: app/Http/Controllers/LlmsTxtController.php
class LlmsTxtController (line 9) | class LlmsTxtController extends Controller
method __invoke (line 11) | public function __invoke()
FILE: app/Http/Middleware/CheckForMaintenanceMode.php
class CheckForMaintenanceMode (line 7) | class CheckForMaintenanceMode extends Middleware
FILE: app/Markdown/Hint/Hint.php
class Hint (line 8) | class Hint extends AbstractBlock implements StringContainerInterface
method getTitle (line 14) | public function getTitle(): ?string
method getType (line 44) | public function getType(): ?string
method getHeaderWords (line 55) | public function getHeaderWords(): array
method setHeader (line 60) | public function setHeader($header)
method setLiteral (line 65) | public function setLiteral(string $literal): void
method getLiteral (line 70) | public function getLiteral(): string
FILE: app/Markdown/Hint/HintExtension.php
class HintExtension (line 8) | class HintExtension implements ExtensionInterface
method register (line 10) | public function register(EnvironmentBuilderInterface $environment): void
FILE: app/Markdown/Hint/HintParser.php
class HintParser (line 11) | class HintParser extends AbstractBlockContinueParser implements BlockCon...
method __construct (line 15) | public function __construct(?string $headerText)
method getBlock (line 21) | public function getBlock(): Hint
method isContainer (line 26) | public function isContainer(): bool
method canContain (line 31) | public function canContain(AbstractBlock $childBlock): bool
method canHaveLazyContinuationLines (line 36) | public function canHaveLazyContinuationLines(): bool
method tryContinue (line 41) | public function tryContinue(Cursor $cursor, BlockContinueParserInterfa...
FILE: app/Markdown/Hint/HintRenderer.php
class HintRenderer (line 10) | final class HintRenderer implements NodeRendererInterface
method render (line 19) | public function render(Node $node, ChildNodeRendererInterface $childRe...
method renderWatch (line 62) | private function renderWatch(Hint $node, ChildNodeRendererInterface $c...
FILE: app/Markdown/Hint/HintStartParser.php
class HintStartParser (line 10) | class HintStartParser implements BlockStartParserInterface
method tryStart (line 12) | public function tryStart(Cursor $cursor, MarkdownParserStateInterface ...
FILE: app/Markdown/Tabs/TabbedCodeBlock.php
class TabbedCodeBlock (line 7) | class TabbedCodeBlock extends AbstractBlock
method addCodeSample (line 12) | public function addCodeSample($language, $code)
method getCodeSamples (line 17) | public function getCodeSamples()
FILE: app/Markdown/Tabs/TabbedCodeBlockExtension.php
class TabbedCodeBlockExtension (line 8) | class TabbedCodeBlockExtension implements ExtensionInterface
method register (line 10) | public function register(EnvironmentBuilderInterface $environment): void
FILE: app/Markdown/Tabs/TabbedCodeStartParser.php
class TabbedCodeStartParser (line 10) | class TabbedCodeStartParser implements BlockStartParserInterface
method tryStart (line 12) | public function tryStart(Cursor $cursor, MarkdownParserStateInterface ...
FILE: app/Markdown/Tabs/TabsParser.php
class TabsParser (line 11) | class TabsParser extends AbstractBlockContinueParser implements BlockCon...
method __construct (line 15) | public function __construct()
method isContainer (line 20) | public function isContainer(): bool
method canContain (line 25) | public function canContain(AbstractBlock $childBlock): bool
method getBlock (line 30) | public function getBlock(): AbstractBlock
method tryContinue (line 35) | public function tryContinue(Cursor $cursor, BlockContinueParserInterfa...
FILE: app/Markdown/Tabs/TabsRenderer.php
class TabsRenderer (line 14) | class TabsRenderer implements NodeRendererInterface
method render (line 22) | public function render(Node $node, ChildNodeRendererInterface $childRe...
FILE: app/Models/User.php
class User (line 13) | #[Fillable(['name', 'email', 'password'])]
method casts (line 25) | protected function casts(): array
FILE: app/Modifiers/Split.php
class Split (line 8) | class Split extends Modifier
method index (line 17) | public function index($value, $params)
FILE: app/Modifiers/Toc.php
class Toc (line 10) | class Toc extends Modifier
method index (line 22) | public function index($value, $params, $context)
method create (line 35) | private function create($content, $maxHeadingLevels)
method valueGet (line 125) | private function valueGet($value)
method slugify (line 134) | private function slugify($text)
FILE: app/Providers/AppServiceProvider.php
class AppServiceProvider (line 19) | class AppServiceProvider extends ServiceProvider
method register (line 24) | public function register(): void
method boot (line 32) | public function boot(): void
FILE: app/Search/DocTransformer.php
class DocTransformer (line 9) | class DocTransformer implements DocumentTransformer
method normalizeConent (line 11) | private function normalizeConent($value)
method handle (line 20) | public function handle(DocumentFragment $fragment, $entry): void
FILE: app/Search/Listeners/SearchEntriesCreatedListener.php
class SearchEntriesCreatedListener (line 7) | class SearchEntriesCreatedListener
method getParentHeadings (line 16) | protected function getParentHeadings($headers, $target)
method handle (line 42) | public function handle(SearchEntriesCreated $event): void
FILE: app/Search/RequestContentRetriever.php
class RequestContentRetriever (line 11) | class RequestContentRetriever implements ContentRetriever
method getContent (line 13) | public function getContent(Entry $entry): string
method extractArticleContent (line 32) | protected function extractArticleContent(string $content): string
FILE: app/Search/Storybook/StorybookSearchProvider.php
class StorybookSearchProvider (line 11) | class StorybookSearchProvider extends Provider
method provide (line 17) | public function provide(): Collection|LazyCollection
method contains (line 27) | public function contains($searchable): bool
method find (line 32) | public function find(array $keys): Collection
FILE: app/Search/Storybook/StorybookSearchable.php
class StorybookSearchable (line 9) | class StorybookSearchable implements SearchableContract
method from (line 16) | public static function from(array $component)
method id (line 26) | public function id(): string
method title (line 31) | public function title(): string
method getSearchValue (line 36) | public function getSearchValue(string $field)
method url (line 53) | public function url(): string
method reference (line 58) | public function reference(): string
FILE: app/Tags/GithubCommitsUrl.php
class GithubCommitsUrl (line 8) | class GithubCommitsUrl extends \Statamic\Tags\Tags
method index (line 10) | public function index()
method getCurrentBranch (line 27) | private function getCurrentBranch(): string
FILE: app/Tags/GithubEditUrl.php
class GithubEditUrl (line 8) | class GithubEditUrl extends \Statamic\Tags\Tags
method index (line 10) | public function index()
method getCurrentBranch (line 27) | private function getCurrentBranch(): string
FILE: app/Tags/HeroSponsors.php
class HeroSponsors (line 12) | class HeroSponsors extends Tags
method index (line 14) | public function index()
method sponsors (line 27) | private function sponsors()
method request (line 46) | private function request($cursor)
method query (line 60) | private function query()
FILE: app/ViewModels/Fieldtypes.php
class Fieldtypes (line 7) | class Fieldtypes extends ViewModel
method data (line 9) | public function data(): array
FILE: app/ViewModels/Modifiers.php
class Modifiers (line 7) | class Modifiers extends ViewModel
method data (line 9) | public function data(): array
FILE: app/ViewModels/Tags.php
class Tags (line 7) | class Tags extends ViewModel
method data (line 9) | public function data(): array
FILE: app/ViewModels/Variables.php
class Variables (line 7) | class Variables extends ViewModel
method data (line 9) | public function data(): array
FILE: database/factories/UserFactory.php
class UserFactory (line 13) | class UserFactory extends Factory
method definition (line 25) | public function definition(): array
method unverified (line 39) | public function unverified(): static
FILE: database/migrations/0001_01_01_000000_create_users_table.php
method up (line 12) | public function up(): void
method down (line 43) | public function down(): void
FILE: database/migrations/0001_01_01_000001_create_cache_table.php
method up (line 12) | public function up(): void
method down (line 30) | public function down(): void
FILE: database/migrations/0001_01_01_000002_create_jobs_table.php
method up (line 12) | public function up(): void
method down (line 51) | public function down(): void
FILE: database/seeders/DatabaseSeeder.php
class DatabaseSeeder (line 9) | class DatabaseSeeder extends Seeder
method run (line 16) | public function run(): void
FILE: resources/js/color-scheme-preferences.js
function updateDarkClass (line 12) | function updateDarkClass(colorScheme) {
function restoreColorSchemePreference (line 29) | function restoreColorSchemePreference() {
function storeColorSchemePreference (line 56) | function storeColorSchemePreference({ target }) {
FILE: resources/js/external-links.js
function isExternal (line 4) | function isExternal(url) {
FILE: resources/js/toc-navigation.js
function tocNavigation (line 1) | function tocNavigation() {
FILE: tests/CreatesApplication.php
type CreatesApplication (line 8) | trait CreatesApplication
method createApplication (line 13) | public function createApplication(): Application
FILE: tests/Feature/ExampleTest.php
class ExampleTest (line 8) | class ExampleTest extends TestCase
method test_the_application_returns_a_successful_response (line 13) | public function test_the_application_returns_a_successful_response(): ...
FILE: tests/TestCase.php
class TestCase (line 7) | abstract class TestCase extends BaseTestCase
FILE: tests/Unit/ExampleTest.php
class ExampleTest (line 7) | class ExampleTest extends TestCase
method test_that_true_is_true (line 12) | public function test_that_true_is_true(): void
Condensed preview — 939 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (2,654K chars).
[
{
"path": ".editorconfig",
"chars": 213,
"preview": "root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\ninsert_final_newline = true\nindent_style = space\nindent_size = 4\ntrim_"
},
{
"path": ".gitattributes",
"chars": 111,
"preview": "* text=auto\n*.css linguist-vendored\n*.scss linguist-vendored\n*.js linguist-vendored\nCHANGELOG.md export-ignore\n"
},
{
"path": ".github/FUNDING.yml",
"chars": 17,
"preview": "github: statamic\n"
},
{
"path": ".gitignore",
"chars": 421,
"preview": ".DS_Store\n/node_modules\n/public/hot\n/public/storage\n/public/vendor/statamic\n/public/build/*\n/users/*\n/public/js\n/public/"
},
{
"path": ".nvmrc",
"chars": 2,
"preview": "22"
},
{
"path": "LICENSE.md",
"chars": 2046,
"preview": "Copyright © Statamic, LLC.\n\nPermission is hereby granted to any person obtaining a copy of this software (the “Software”"
},
{
"path": "README.md",
"chars": 2337,
"preview": "<p align=\"center\"><img src=\"https://statamic.com/assets/branding/Statamic-Logo+Wordmark-Rad.svg\" width=\"400\" alt=\"Statam"
},
{
"path": "app/Http/Controllers/Controller.php",
"chars": 361,
"preview": "<?php\n\nnamespace App\\Http\\Controllers;\n\nuse Illuminate\\Foundation\\Auth\\Access\\AuthorizesRequests;\nuse Illuminate\\Foundat"
},
{
"path": "app/Http/Controllers/DocsMarkdownController.php",
"chars": 1621,
"preview": "<?php\n\nnamespace App\\Http\\Controllers;\n\nuse Illuminate\\Support\\Facades\\Cache;\nuse Statamic\\Exceptions\\NotFoundHttpExcept"
},
{
"path": "app/Http/Controllers/LlmsTxtController.php",
"chars": 2104,
"preview": "<?php\n\nnamespace App\\Http\\Controllers;\n\nuse Illuminate\\Support\\Facades\\Cache;\nuse Statamic\\Facades\\Collection;\nuse Stata"
},
{
"path": "app/Http/Middleware/CheckForMaintenanceMode.php",
"chars": 335,
"preview": "<?php\n\nnamespace App\\Http\\Middleware;\n\nuse Illuminate\\Foundation\\Http\\Middleware\\CheckForMaintenanceMode as Middleware;\n"
},
{
"path": "app/Markdown/Hint/Hint.php",
"chars": 1437,
"preview": "<?php\n\nnamespace App\\Markdown\\Hint;\n\nuse League\\CommonMark\\Node\\Block\\AbstractBlock;\nuse League\\CommonMark\\Node\\StringCo"
},
{
"path": "app/Markdown/Hint/HintExtension.php",
"chars": 426,
"preview": "<?php\n\nnamespace App\\Markdown\\Hint;\n\nuse League\\CommonMark\\Environment\\EnvironmentBuilderInterface;\nuse League\\CommonMar"
},
{
"path": "app/Markdown/Hint/HintParser.php",
"chars": 1182,
"preview": "<?php\n\nnamespace App\\Markdown\\Hint;\n\nuse League\\CommonMark\\Node\\Block\\AbstractBlock;\nuse League\\CommonMark\\Parser\\Block\\"
},
{
"path": "app/Markdown/Hint/HintRenderer.php",
"chars": 2458,
"preview": "<?php\n\nnamespace App\\Markdown\\Hint;\n\nuse League\\CommonMark\\Node\\Node;\nuse League\\CommonMark\\Renderer\\ChildNodeRendererIn"
},
{
"path": "app/Markdown/Hint/HintStartParser.php",
"chars": 803,
"preview": "<?php\n\nnamespace App\\Markdown\\Hint;\n\nuse League\\CommonMark\\Parser\\Block\\BlockStart;\nuse League\\CommonMark\\Parser\\Block\\B"
},
{
"path": "app/Markdown/Tabs/TabbedCodeBlock.php",
"chars": 417,
"preview": "<?php\n\nnamespace App\\Markdown\\Tabs;\n\nuse League\\CommonMark\\Node\\Block\\AbstractBlock;\n\nclass TabbedCodeBlock extends Abst"
},
{
"path": "app/Markdown/Tabs/TabbedCodeBlockExtension.php",
"chars": 454,
"preview": "<?php\n\nnamespace App\\Markdown\\Tabs;\n\nuse League\\CommonMark\\Environment\\EnvironmentBuilderInterface;\nuse League\\CommonMar"
},
{
"path": "app/Markdown/Tabs/TabbedCodeStartParser.php",
"chars": 790,
"preview": "<?php\n\nnamespace App\\Markdown\\Tabs;\n\nuse League\\CommonMark\\Parser\\Block\\BlockStart;\nuse League\\CommonMark\\Parser\\Block\\B"
},
{
"path": "app/Markdown/Tabs/TabsParser.php",
"chars": 1054,
"preview": "<?php\n\nnamespace App\\Markdown\\Tabs;\n\nuse League\\CommonMark\\Node\\Block\\AbstractBlock;\nuse League\\CommonMark\\Parser\\Block\\"
},
{
"path": "app/Markdown/Tabs/TabsRenderer.php",
"chars": 2868,
"preview": "<?php\n\nnamespace App\\Markdown\\Tabs;\n\nuse Illuminate\\Support\\Str;\nuse League\\CommonMark\\Extension\\CommonMark\\Node\\Block\\F"
},
{
"path": "app/Models/User.php",
"chars": 840,
"preview": "<?php\n\nnamespace App\\Models;\n\n// use Illuminate\\Contracts\\Auth\\MustVerifyEmail;\nuse Database\\Factories\\UserFactory;\nuse "
},
{
"path": "app/Modifiers/Split.php",
"chars": 562,
"preview": "<?php\n\nnamespace App\\Modifiers;\n\nuse Statamic\\Modifiers\\Modifier;\nuse Statamic\\Support\\Arr;\n\nclass Split extends Modifie"
},
{
"path": "app/Modifiers/Toc.php",
"chars": 4659,
"preview": "<?php\n\nnamespace App\\Modifiers;\n\nuse Illuminate\\Support\\Arr;\nuse Illuminate\\Support\\Str;\nuse Statamic\\Modifiers\\Modifier"
},
{
"path": "app/Providers/AppServiceProvider.php",
"chars": 1825,
"preview": "<?php\n\nnamespace App\\Providers;\n\nuse App\\Markdown\\Hint\\HintExtension;\nuse App\\Markdown\\Tabs\\TabbedCodeBlockExtension;\nus"
},
{
"path": "app/Search/DocTransformer.php",
"chars": 966,
"preview": "<?php\n\nnamespace App\\Search;\n\nuse Illuminate\\Support\\Str;\nuse Stillat\\DocumentationSearch\\Contracts\\DocumentTransformer;"
},
{
"path": "app/Search/Listeners/SearchEntriesCreatedListener.php",
"chars": 3598,
"preview": "<?php\n\nnamespace App\\Search\\Listeners;\n\nuse Stillat\\DocumentationSearch\\Events\\SearchEntriesCreated;\n\nclass SearchEntrie"
},
{
"path": "app/Search/RequestContentRetriever.php",
"chars": 1229,
"preview": "<?php\n\nnamespace App\\Search;\n\nuse DOMDocument;\nuse Illuminate\\Http\\Request;\nuse Statamic\\Contracts\\Entries\\Entry;\nuse St"
},
{
"path": "app/Search/Storybook/StorybookSearchProvider.php",
"chars": 1131,
"preview": "<?php\n\nnamespace App\\Search\\Storybook;\n\nuse Illuminate\\Support\\Collection;\nuse Illuminate\\Support\\Facades\\Http;\nuse Illu"
},
{
"path": "app/Search/Storybook/StorybookSearchable.php",
"chars": 1298,
"preview": "<?php\n\nnamespace App\\Search\\Storybook;\n\nuse Illuminate\\Support\\Str;\nuse Statamic\\Contracts\\Search\\Searchable as Searchab"
},
{
"path": "app/Tags/GithubCommitsUrl.php",
"chars": 771,
"preview": "<?php\n\nnamespace App\\Tags;\n\nuse Illuminate\\Support\\Str;\nuse Statamic\\Facades\\Data;\n\nclass GithubCommitsUrl extends \\Stat"
},
{
"path": "app/Tags/GithubEditUrl.php",
"chars": 773,
"preview": "<?php\n\nnamespace App\\Tags;\n\nuse Illuminate\\Support\\Str;\nuse Statamic\\Facades\\Data;\n\nclass GithubEditUrl extends \\Statami"
},
{
"path": "app/Tags/HeroSponsors.php",
"chars": 2811,
"preview": "<?php\n\nnamespace App\\Tags;\n\nuse Illuminate\\Support\\Facades\\Cache;\nuse Illuminate\\Support\\Facades\\Http;\nuse Illuminate\\Su"
},
{
"path": "app/ViewModels/Fieldtypes.php",
"chars": 229,
"preview": "<?php\n\nnamespace App\\ViewModels;\n\nuse Statamic\\View\\ViewModel;\n\nclass Fieldtypes extends ViewModel\n{\n public function"
},
{
"path": "app/ViewModels/Modifiers.php",
"chars": 227,
"preview": "<?php\n\nnamespace App\\ViewModels;\n\nuse Statamic\\View\\ViewModel;\n\nclass Modifiers extends ViewModel\n{\n public function "
},
{
"path": "app/ViewModels/Tags.php",
"chars": 216,
"preview": "<?php\n\nnamespace App\\ViewModels;\n\nuse Statamic\\View\\ViewModel;\n\nclass Tags extends ViewModel\n{\n public function data("
},
{
"path": "app/ViewModels/Variables.php",
"chars": 217,
"preview": "<?php\n\nnamespace App\\ViewModels;\n\nuse Statamic\\View\\ViewModel;\n\nclass Variables extends ViewModel\n{\n public function "
},
{
"path": "artisan",
"chars": 350,
"preview": "#!/usr/bin/env php\n<?php\n\nuse Symfony\\Component\\Console\\Input\\ArgvInput;\n\ndefine('LARAVEL_START', microtime(true));\n\n// "
},
{
"path": "bootstrap/app.php",
"chars": 525,
"preview": "<?php\n\nuse Illuminate\\Foundation\\Application;\nuse Illuminate\\Foundation\\Configuration\\Exceptions;\nuse Illuminate\\Foundat"
},
{
"path": "bootstrap/cache/.gitignore",
"chars": 14,
"preview": "*\n!.gitignore\n"
},
{
"path": "bootstrap/providers.php",
"chars": 89,
"preview": "<?php\n\nuse App\\Providers\\AppServiceProvider;\n\nreturn [\n AppServiceProvider::class,\n];\n"
},
{
"path": "composer.json",
"chars": 2090,
"preview": "{\n \"name\": \"laravel/laravel\",\n \"type\": \"project\",\n \"description\": \"The Laravel Framework.\",\n \"keywords\": [\n "
},
{
"path": "config/app.php",
"chars": 4269,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Applicatio"
},
{
"path": "config/auth.php",
"chars": 4356,
"preview": "<?php\n\nuse App\\Models\\User;\n\nreturn [\n\n /*\n |---------------------------------------------------------------------"
},
{
"path": "config/cache.php",
"chars": 4295,
"preview": "<?php\n\nuse Illuminate\\Support\\Str;\n\nreturn [\n\n /*\n |--------------------------------------------------------------"
},
{
"path": "config/database.php",
"chars": 6982,
"preview": "<?php\n\nuse Illuminate\\Support\\Str;\nuse Pdo\\Mysql;\n\nreturn [\n\n /*\n |-----------------------------------------------"
},
{
"path": "config/docs.php",
"chars": 358,
"preview": "<?php\n\nreturn [\n\n 'version' => env('STATAMIC_DOCS_VERSION', '6'),\n\n 'versions' => [\n [\n 'version"
},
{
"path": "config/filesystems.php",
"chars": 2862,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Default Fi"
},
{
"path": "config/logging.php",
"chars": 4340,
"preview": "<?php\n\nuse Monolog\\Handler\\NullHandler;\nuse Monolog\\Handler\\StreamHandler;\nuse Monolog\\Handler\\SyslogUdpHandler;\nuse Mon"
},
{
"path": "config/mail.php",
"chars": 3631,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Default Ma"
},
{
"path": "config/queue.php",
"chars": 4195,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Default Qu"
},
{
"path": "config/services.php",
"chars": 1105,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Third Part"
},
{
"path": "config/session.php",
"chars": 8419,
"preview": "<?php\n\nuse Illuminate\\Support\\Str;\n\nreturn [\n\n /*\n |--------------------------------------------------------------"
},
{
"path": "config/statamic/antlers.php",
"chars": 1660,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Debugbar\n "
},
{
"path": "config/statamic/api.php",
"chars": 2893,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | API\n |-"
},
{
"path": "config/statamic/assets.php",
"chars": 9489,
"preview": "<?php\n\nreturn [\n\n 'image_manipulation' => [\n\n /*\n |----------------------------------------------------"
},
{
"path": "config/statamic/autosave.php",
"chars": 1088,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Enable aut"
},
{
"path": "config/statamic/cp.php",
"chars": 3838,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Control Pa"
},
{
"path": "config/statamic/editions.php",
"chars": 107,
"preview": "<?php\n\nreturn [\n\n 'pro' => env('STATAMIC_PRO_ENABLED', false),\n\n 'addons' => [\n //\n ],\n\n];\n"
},
{
"path": "config/statamic/forms.php",
"chars": 1533,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Forms Path"
},
{
"path": "config/statamic/git.php",
"chars": 6303,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Git Integr"
},
{
"path": "config/statamic/graphql.php",
"chars": 2813,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | GraphQL\n "
},
{
"path": "config/statamic/live_preview.php",
"chars": 1828,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Devices\n "
},
{
"path": "config/statamic/markdown.php",
"chars": 931,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Markdown P"
},
{
"path": "config/statamic/oauth.php",
"chars": 1980,
"preview": "<?php\n\nreturn [\n\n 'enabled' => env('STATAMIC_OAUTH_ENABLED', false),\n\n 'email_login_enabled' => true,\n\n 'provid"
},
{
"path": "config/statamic/protect.php",
"chars": 1407,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Default (o"
},
{
"path": "config/statamic/revisions.php",
"chars": 510,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Revisions\n"
},
{
"path": "config/statamic/routes.php",
"chars": 1630,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Enable Rou"
},
{
"path": "config/statamic/search.php",
"chars": 4394,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Default se"
},
{
"path": "config/statamic/stache.php",
"chars": 3073,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | File Watch"
},
{
"path": "config/statamic/static_caching.php",
"chars": 5503,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Active Sta"
},
{
"path": "config/statamic/system.php",
"chars": 9762,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | License Ke"
},
{
"path": "config/statamic/templates.php",
"chars": 1130,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Template L"
},
{
"path": "config/statamic/users.php",
"chars": 6274,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | User Repos"
},
{
"path": "config/statamic/webauthn.php",
"chars": 1228,
"preview": "<?php\n\nreturn [\n\n /*\n |--------------------------------------------------------------------------\n | Allow pass"
},
{
"path": "config/torchlight.php",
"chars": 1961,
"preview": "<?php\n\nreturn [\n // The Torchlight client caches highlighted code blocks. Here\n // you can define which cache driv"
},
{
"path": "content/assets/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "content/assets/main.yaml",
"chars": 25,
"preview": "title: Main\ndisk: assets\n"
},
{
"path": "content/collections/.gitkeep",
"chars": 0,
"preview": ""
},
{
"path": "content/collections/fieldtypes/array.md",
"chars": 5348,
"preview": "---\ntitle: Array\nmeta_title: Array Fieldtype\nintro: Manage data in a `key:value` array format.\noverview: |\n The array f"
},
{
"path": "content/collections/fieldtypes/assets.md",
"chars": 8894,
"preview": "---\ntitle: Assets\nmeta_title: Assets Fieldtype\nintro: Any time you want to list, display, or work with assets (external "
},
{
"path": "content/collections/fieldtypes/bard.md",
"chars": 18770,
"preview": "---\ntitle: Bard\ndescription: \"Rich article writing and block-based layouts made easy.\"\nintro: |\n Bard is more than just"
},
{
"path": "content/collections/fieldtypes/button_group.md",
"chars": 2104,
"preview": "---\ntitle: 'Button Group'\ndescription: 'Buttons you click. You can only choose one.'\nintro: |\n Buttons. Create some opt"
},
{
"path": "content/collections/fieldtypes/checkboxes.md",
"chars": 3051,
"preview": "---\ntitle: Checkboxes\ndescription: Boxes you check. You can check 'em all.\nintro: >\n Checkboxes! Make some checkboxes, "
},
{
"path": "content/collections/fieldtypes/code.md",
"chars": 3963,
"preview": "---\ntitle: Code\ndescription: 'Write code and see it highlight. But will you choose spaces or tabs?'\nintro: What are you "
},
{
"path": "content/collections/fieldtypes/collections.md",
"chars": 1485,
"preview": "---\ntitle: Collections\nextends: 9dd58c40-6e33-49c8-83fa-61a69f6371be\ndescription: Choose from one or more collections.\no"
},
{
"path": "content/collections/fieldtypes/color.md",
"chars": 1586,
"preview": "---\ntitle: Color\ndescription: 'Manage colors by hex code with swatches and text inputs.'\nintro: 'A simple color picker w"
},
{
"path": "content/collections/fieldtypes/date.md",
"chars": 7345,
"preview": "---\ntitle: Date\ndescription: Helps you pick a date, but not get one.\nintro: >\n Work with dates, times, and ranges with "
},
{
"path": "content/collections/fieldtypes/dictionary.md",
"chars": 6423,
"preview": "---\ntitle: Dictionary\ndescription: Choose from options provided by dictionaries.\nintro: Give your users a list of option"
},
{
"path": "content/collections/fieldtypes/entries.md",
"chars": 2918,
"preview": "---\ntitle: Entries\nmeta_title: 'Entries Fieldtype'\ndescription: 'Create relationships with other entries.'\nintro: |\n Cr"
},
{
"path": "content/collections/fieldtypes/float.md",
"chars": 1204,
"preview": "---\ntitle: Float\ndescription: 'For when all you want is decimal numbers.'\nintro: 'The float fieldtype is a text-style in"
},
{
"path": "content/collections/fieldtypes/form.md",
"chars": 1598,
"preview": "---\nid: d630ea15-d94f-4404-84d2-0926a898e672\nblueprint: fieldtype\ntitle: Form\nscreenshot: fieldtypes/screenshots/v6/form"
},
{
"path": "content/collections/fieldtypes/grid.md",
"chars": 2603,
"preview": "---\ntitle: Grid\ndescription: Manage columns of dynamic rows of data that can contain any other fieldtypes.\noverview: >\n "
},
{
"path": "content/collections/fieldtypes/group.md",
"chars": 1093,
"preview": "---\nid: 9780cee8-0732-40b5-bc71-ed846d0c290d\nblueprint: fieldtype\ntitle: Group\ndescription: 'Group fields visually and s"
},
{
"path": "content/collections/fieldtypes/hidden.md",
"chars": 623,
"preview": "---\ntitle: Hidden\ndescription: Set default data when creating new entries.\noverview: \"The hidden field is perfect for se"
},
{
"path": "content/collections/fieldtypes/html.md",
"chars": 770,
"preview": "---\ntitle: HTML\nmeta_title: 'HTML Fieldtype'\ndescription: 'Add a little presentation-only HTML to your blueprint.'\nintro"
},
{
"path": "content/collections/fieldtypes/icon.md",
"chars": 2116,
"preview": "---\nid: 50ed54f8-18b3-4b46-b0d7-6fedc07ad81f\nblueprint: fieldtype\ntitle: Icon\ndescription: 'Simple UI to select SVG icon"
},
{
"path": "content/collections/fieldtypes/integer.md",
"chars": 1230,
"preview": "---\ntitle: Integer\ndescription: 'For when all you want is numbers.'\nintro: 'The integer fieldtype is a text-style input "
},
{
"path": "content/collections/fieldtypes/link.md",
"chars": 2481,
"preview": "---\ntitle: Link\ndescription: 'Create links to URLs, entries, or child entries.'\nintro: |\n A select box gives you the op"
},
{
"path": "content/collections/fieldtypes/list.md",
"chars": 1312,
"preview": "---\ntitle: List\ndescription: Manage simple lists with the help of a keyboard-friendly interface.\nintro: >\n Create YAML "
},
{
"path": "content/collections/fieldtypes/markdown.md",
"chars": 4052,
"preview": "---\ntitle: Markdown\ndescription: Our beautiful Markdown editor with preview, assets integration, and more.\nintro: Write "
},
{
"path": "content/collections/fieldtypes/navs.md",
"chars": 1858,
"preview": "---\ntitle: Navs\nmeta_title: 'Navs Fieldtype'\ndescription: Choose from one or more navigations.\noverview: Allows you to c"
},
{
"path": "content/collections/fieldtypes/radio.md",
"chars": 1935,
"preview": "---\ntitle: Radio\ndescription: 'Circles you click. You can only choose one.'\nintro: |\n Radio buttons. The \"you can only "
},
{
"path": "content/collections/fieldtypes/range.md",
"chars": 1308,
"preview": "---\ntitle: Range\ndescription: 'Choose a number between a min and max value.'\nintro: |\n Range fields let the user choose"
},
{
"path": "content/collections/fieldtypes/replicator.md",
"chars": 8220,
"preview": "---\ntitle: Replicator\ndescription: Build your content by creating sets of fields you can mix and match on the fly.\noverv"
},
{
"path": "content/collections/fieldtypes/revealer.md",
"chars": 2101,
"preview": "---\ntitle: Revealer\ndescription: A button that reveals conditional fields like magic.\nintro: The revealer is a simple bu"
},
{
"path": "content/collections/fieldtypes/select.md",
"chars": 3145,
"preview": "---\ntitle: Select\ndescription: Choose from predefined options. This field is highly configurable.\nintro: Give your users"
},
{
"path": "content/collections/fieldtypes/sites.md",
"chars": 1529,
"preview": "---\nid: db0162b1-c58c-4093-841c-b386cc2e5c21\nblueprint: fieldtype\ntitle: Sites\nscreenshot: fieldtypes/screenshots/v6/sit"
},
{
"path": "content/collections/fieldtypes/slug.md",
"chars": 822,
"preview": "---\nid: cbc7ecef-155f-45c0-9ac4-e815e120fa99\nblueprint: fieldtype\ntitle: Slug\nscreenshot: fieldtypes/screenshots/v6/slug"
},
{
"path": "content/collections/fieldtypes/spacer.md",
"chars": 365,
"preview": "---\ntitle: Spacer\ndescription: An invisible field to help you structure your blueprints and forms.\noverview: \"The Spacer"
},
{
"path": "content/collections/fieldtypes/structures.md",
"chars": 2032,
"preview": "---\ntitle: Structures\nmeta_title: 'Structures Fieldtype'\ndescription: 'Create relationships with structures.'\nintro: |\n "
},
{
"path": "content/collections/fieldtypes/table.md",
"chars": 3586,
"preview": "---\ntitle: Table\ndescription: Create and manage simple tables of limitless columns and rows.\nintro: >\n Creating tables "
},
{
"path": "content/collections/fieldtypes/taggable.md",
"chars": 1394,
"preview": "---\ntitle: Tags\nscreenshot: fieldtypes/screenshots/v6/taggable.webp\nscreenshot_dark: fieldtypes/screenshots/v6/taggable-"
},
{
"path": "content/collections/fieldtypes/taxonomies.md",
"chars": 1654,
"preview": "---\nid: 88c9909c-4134-40cd-b095-79ec7207b190\nblueprint: fieldtype\ntitle: Taxonomies\ndescription: 'Choose from one or mor"
},
{
"path": "content/collections/fieldtypes/template.md",
"chars": 746,
"preview": "---\ntitle: Template\ndescription: A template picker with autosuggest.\nintro: >\n Used for choosing an entry’s template. B"
},
{
"path": "content/collections/fieldtypes/terms.md",
"chars": 3744,
"preview": "---\ntitle: Terms\nextends: 9dd58c40-6e33-49c8-83fa-61a69f6371be\ndescription: Attach Taxonomy Terms to your content.\nintro"
},
{
"path": "content/collections/fieldtypes/text.md",
"chars": 1279,
"preview": "---\ntitle: Text\ndescription: A simple text input field for managing short, unformatted text.\noverview: >\n A text field "
},
{
"path": "content/collections/fieldtypes/textarea.md",
"chars": 817,
"preview": "---\ntitle: Textarea\ndescription: |\n A simple textarea field for managing longer, unformatted text.\noverview: |\n A long"
},
{
"path": "content/collections/fieldtypes/time.md",
"chars": 428,
"preview": "---\ntitle: Time\ndescription: A timepicker. It lets you pick a time.\nintro: The original time field from the set of Kiefe"
},
{
"path": "content/collections/fieldtypes/toggle.md",
"chars": 2074,
"preview": "---\ntitle: Toggle\ndescription: A toggle switch for booleans (`true` and `false`).\nintro: A nice little toggle switch gen"
},
{
"path": "content/collections/fieldtypes/user-groups.md",
"chars": 2027,
"preview": "---\nid: 006ee3c1-607e-4d65-94ae-6862c18ac516\ntitle: User Groups\nscreenshot: fieldtypes/screenshots/v6/user-groups.webp\ns"
},
{
"path": "content/collections/fieldtypes/user-roles.md",
"chars": 1995,
"preview": "---\nid: 42baf054-f3d5-4317-b7dd-466882c47c06\nblueprint: fieldtype\ntitle: 'User Roles'\nscreenshot: fieldtypes/screenshots"
},
{
"path": "content/collections/fieldtypes/users.md",
"chars": 3523,
"preview": "---\ntitle: Users\ndescription: Relate users with your content.\nintro: >\n Attach users to your content to show authorship"
},
{
"path": "content/collections/fieldtypes/video.md",
"chars": 1724,
"preview": "---\ntitle: Video\ndescription: Extract embed URLs from Youtube, Vimeo, and HTML5 compatible video links and preview them "
},
{
"path": "content/collections/fieldtypes/width.md",
"chars": 1499,
"preview": "---\nid: b8b51bb8-a4bd-4aec-90bd-4f150a29c8a0\nblueprint: fieldtype\ntitle: Width\nscreenshot: fieldtypes/screenshots/v6/wid"
},
{
"path": "content/collections/fieldtypes/yaml.md",
"chars": 1049,
"preview": "---\ntitle: YAML\ndescription: A YAML editor that _directly_ manages YAML.\noverview: >\n A [code fieldtype](/fieldtypes/ya"
},
{
"path": "content/collections/fieldtypes.yaml",
"chars": 337,
"preview": "title: Fieldtypes\nicon: fieldsets\ntemplate: page\nlayout: layout\nmount: 25f01cb5-1ca9-44a1-af1b-885b32b05cc8\nrevisions: f"
},
{
"path": "content/collections/modifiers/add.md",
"chars": 706,
"preview": "---\nid: 53debd55-5d53-4254-ad86-49a26cb09594\nblueprint: modifiers\nmodifier_types:\n - math\ntitle: Add\n---\nAdd a value or"
},
{
"path": "content/collections/modifiers/add_slashes.md",
"chars": 622,
"preview": "---\nid: c5832187-290e-4701-aa74-316d8130e7bb\nmodifier_types:\n - string\ntitle: 'Add Slashes'\n---\nModifies a string by ad"
},
{
"path": "content/collections/modifiers/ampersand_list.md",
"chars": 658,
"preview": "---\nid: cbab1bb5-302e-499d-badb-f154dbae751d\nblueprint: modifiers\nmodifier_types:\n - array\n - markup\ntitle: 'Ampersand"
},
{
"path": "content/collections/modifiers/antlers.md",
"chars": 384,
"preview": "---\nid: e3b58c77-0bfc-40da-918f-51a7f65950b8\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: Antlers\n"
},
{
"path": "content/collections/modifiers/as.md",
"chars": 736,
"preview": "---\nid: ada24ec2-1b6e-4759-b2c0-06d9d464f3f9\nblueprint: modifiers\nmodifier_types:\n - array\n - utility\ntitle: As\n---\nAl"
},
{
"path": "content/collections/modifiers/ascii.md",
"chars": 505,
"preview": "---\nid: 807d2a16-dbaa-4aaf-887c-9682b63a6af8\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: Ascii\n---\nReplaces a"
},
{
"path": "content/collections/modifiers/at.md",
"chars": 408,
"preview": "---\nid: 40fb38b6-a2b0-411d-b90b-543b38ac8aa3\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: At\n---\nReturns the s"
},
{
"path": "content/collections/modifiers/attribute.md",
"chars": 949,
"preview": "---\nid: 9840b1ab-4576-4cc9-9b83-9226d069807d\nblueprint: modifiers\nmodifier_types:\n - string\n - array\ntitle: Attribute\n"
},
{
"path": "content/collections/modifiers/background_position.md",
"chars": 516,
"preview": "---\nid: 0904f610-eee8-4b86-827b-0dc281d553ca\nblueprint: modifiers\nmodifier_types:\n - asset\n - string\ntitle: 'Backgroun"
},
{
"path": "content/collections/modifiers/backspace.md",
"chars": 394,
"preview": "---\nid: 9526d59a-3abe-444f-b9a4-b0a8ed2fa880\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: Backspace\n---\nRemove"
},
{
"path": "content/collections/modifiers/bard_html.md",
"chars": 1340,
"preview": "---\nid: e2b731c3-13aa-42c8-96f1-9b999a0121e0\nblueprint: modifiers\ntitle: 'Bard HTML'\nmodifier_types:\n - array\n - strin"
},
{
"path": "content/collections/modifiers/bard_items.md",
"chars": 3308,
"preview": "---\nid: 3c1a5985-1157-4287-801f-95a44b158c82\nblueprint: modifiers\ntitle: 'Bard Items'\nmodifier_types:\n - array\n - util"
},
{
"path": "content/collections/modifiers/bard_text.md",
"chars": 1445,
"preview": "---\nid: 5a617e74-0878-4b29-bd39-f1e2496d01cd\nblueprint: modifiers\ntitle: 'Bard Text'\nmodifier_types:\n - array\n - strin"
},
{
"path": "content/collections/modifiers/bool_string.md",
"chars": 711,
"preview": "---\nid: c3214196-3d0d-4a3d-b6c3-1ee4960cfedd\nblueprint: modifiers\nmodifier_types:\n - utility\ntitle: 'Bool String'\n---\nC"
},
{
"path": "content/collections/modifiers/camelize.md",
"chars": 578,
"preview": "---\nid: fe6dbf39-7870-4aa4-9acb-23b4cbf4bf87\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: Camelize\n---\nReturns"
},
{
"path": "content/collections/modifiers/cdata.md",
"chars": 470,
"preview": "---\nid: f1b59bce-43e7-41a4-b82f-e16016d90b18\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: CDATA\n--"
},
{
"path": "content/collections/modifiers/ceil.md",
"chars": 333,
"preview": "---\nid: 29863a25-6283-4338-baf5-82bd7c57541c\nblueprint: modifiers\nmodifier_types:\n - math\n - utility\ntitle: Ceil\n---\nR"
},
{
"path": "content/collections/modifiers/chunk.md",
"chars": 1872,
"preview": "---\nid: 10b38f50-e33c-47e0-8e94-bc4dc551600f\nblueprint: modifiers\nmodifier_types:\n - array\n - markup\n - utility\ntitle"
},
{
"path": "content/collections/modifiers/classes.md",
"chars": 1004,
"preview": "---\nid: ef8d4f96-e811-4343-a2cf-81e455ee8227\nblueprint: modifiers\nmodifier_types:\n - string\n - array\ntitle: Classes\n--"
},
{
"path": "content/collections/modifiers/collapse.md",
"chars": 529,
"preview": "---\nid: ea17da24-79b9-4ac7-84ba-660b29f95899\nblueprint: modifiers\nmodifier_types:\n - array\n - utility\ntitle: Collapse\n"
},
{
"path": "content/collections/modifiers/collapse_whitespace.md",
"chars": 556,
"preview": "---\nid: bfc66a6c-e4f5-462b-822e-04c3402b5b8f\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: 'Collapse Whitespace"
},
{
"path": "content/collections/modifiers/compact.md",
"chars": 883,
"preview": "---\nid: a29dcde5-5708-4ed3-8d00-76f818095477\nblueprint: modifiers\nmodifier_types:\n - array\n - utility\ntitle: Compact\n-"
},
{
"path": "content/collections/modifiers/console_log.md",
"chars": 451,
"preview": "---\nid: 985dc29c-fe71-464e-bb83-4f3f2aa455c0\nblueprint: modifiers\nmodifier_types:\n - utility\ntitle: 'Console Log'\n---\nD"
},
{
"path": "content/collections/modifiers/contains.md",
"chars": 3010,
"preview": "---\nid: 75145be0-966f-490e-af3d-ed122eb6445b\nblueprint: modifiers\nmodifier_types:\n - conditions\n - array\n - string\nti"
},
{
"path": "content/collections/modifiers/contains_all.md",
"chars": 674,
"preview": "---\nid: e08b1034-5d58-4fae-8f6a-8efd9a65d6d9\nblueprint: modifiers\nmodifier_types:\n - conditions\ntitle: 'Contains All'\n-"
},
{
"path": "content/collections/modifiers/contains_any.md",
"chars": 546,
"preview": "---\nid: 20ac3e9a-4a45-4c2f-9052-be222fc84016\nblueprint: modifiers\nmodifier_types:\n - conditions\ntitle: 'Contains Any'\n-"
},
{
"path": "content/collections/modifiers/count.md",
"chars": 343,
"preview": "---\nid: a7b58312-3498-4807-b2bc-6fcb640fe231\nblueprint: modifiers\nmodifier_types:\n - array\ntitle: Count\n---\nCount the n"
},
{
"path": "content/collections/modifiers/count_substring.md",
"chars": 689,
"preview": "---\nid: 84c6f375-10ca-4296-89a8-a22b9652b5d5\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: 'Count Substring'\n--"
},
{
"path": "content/collections/modifiers/dashify.md",
"chars": 529,
"preview": "---\nid: e50e2b3a-4377-4a74-b25a-d1ecf5d2d04a\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: Dashify\n---\nReturns "
},
{
"path": "content/collections/modifiers/days_ago.md",
"chars": 884,
"preview": "---\nid: 811c1cf5-797f-4e77-af92-fde6c03e96d2\nblueprint: modifiers\nmodifier_types:\n - date\nparse_content: true\ntitle: 'D"
},
{
"path": "content/collections/modifiers/decode.md",
"chars": 676,
"preview": "---\nid: 1fd780fd-ae92-4e73-9513-2b9c845976e9\nblueprint: modifiers\nmodifier_types:\n - utility\ntitle: Decode\n---\nConvert "
},
{
"path": "content/collections/modifiers/deslugify.md",
"chars": 417,
"preview": "---\nid: 826517cc-7273-4045-bca2-fe5825fd9bda\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: Deslugify\n---\nReplac"
},
{
"path": "content/collections/modifiers/divide.md",
"chars": 501,
"preview": "---\nid: fedbc5fc-2478-4fba-92ba-4004bc6e8845\nblueprint: modifiers\nmodifier_types:\n - math\ntitle: Divide\n---\nDivide a va"
},
{
"path": "content/collections/modifiers/dl.md",
"chars": 550,
"preview": "---\nid: fbdb7bf5-ac19-444c-9536-57332ffff388\nblueprint: modifiers\nmodifier_types:\n - array\n - markup\ntitle: DL\n---\nTur"
},
{
"path": "content/collections/modifiers/doesnt_overlap.md",
"chars": 1034,
"preview": "---\nid: 948e8351-70ba-4263-a3d5-34dfff0551d5\nblueprint: modifiers\nmodifier_types:\n - array\n - conditions\ntitle: \"Doesn"
},
{
"path": "content/collections/modifiers/dump.md",
"chars": 545,
"preview": "---\nid: 12de1a6c-e8be-4703-81a3-fc270311bc84\nblueprint: modifiers\nmodifier_types:\n - utility\ntitle: Dump\n---\nDump a var"
},
{
"path": "content/collections/modifiers/embed_url.md",
"chars": 821,
"preview": "---\nid: 45310885-fbd3-438d-85d5-076dda1646e0\nblueprint: modifiers\nmodifier_types:\n - string\ntitle: 'Embed Url'\n---\nConv"
},
{
"path": "content/collections/modifiers/ends_with.md",
"chars": 590,
"preview": "---\nid: 40fc5b1e-d0e7-488a-bf6e-e6ef4a8b7dd8\nblueprint: modifiers\nmodifier_types:\n - conditions\ntitle: 'Ends With'\n---\n"
},
{
"path": "content/collections/modifiers/ensure_left.md",
"chars": 592,
"preview": "---\nid: 171d9329-c456-45ca-a5e4-fc5bad7fb0ec\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: 'Ensure "
},
{
"path": "content/collections/modifiers/ensure_right.md",
"chars": 563,
"preview": "---\nid: 6854539a-4661-483b-bb1f-2d28df0db76e\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: 'Ensure "
},
{
"path": "content/collections/modifiers/entities.md",
"chars": 604,
"preview": "---\nid: 50c06e32-9b94-4129-85ba-7cc4201b9e3f\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: Entities"
},
{
"path": "content/collections/modifiers/excerpt.md",
"chars": 734,
"preview": "---\nid: 051ecd7b-1cf7-4b47-b8c1-cfcede33289f\nblueprint: modifiers\ntitle: Excerpt\nintro: 'Generate an excerpt from your c"
},
{
"path": "content/collections/modifiers/explode.md",
"chars": 818,
"preview": "---\nid: c3d3e2c4-218e-4841-a594-647f10863866\nblueprint: modifiers\nmodifier_types:\n - string\n - array\ntitle: Explode\n--"
},
{
"path": "content/collections/modifiers/favicon.md",
"chars": 452,
"preview": "---\nid: 9c7ad945-2d02-423b-ae97-09cbe7ffed0d\nblueprint: modifiers\nmodifier_types:\n - markup\nattributes: true\ntitle: Fav"
},
{
"path": "content/collections/modifiers/filter_empty.md",
"chars": 283,
"preview": "---\nid: a01e28a5-7c59-436c-8137-98e9481631ba\nmodifier_types:\n - array\ntitle: 'Filter Empty'\n---\nFilters out null values"
},
{
"path": "content/collections/modifiers/first.md",
"chars": 548,
"preview": "---\nid: 3ef1e731-742e-48c2-81f0-6fa916ecda0a\nblueprint: modifiers\nmodifier_types:\n - markup\n - string\n - utility\n - "
},
{
"path": "content/collections/modifiers/flatten.md",
"chars": 952,
"preview": "---\nid: e893345c-03f7-466b-a400-bbd2545bd780\nblueprint: modifiers\nmodifier_types:\n - array\n - utility\ntitle: Flatten\n-"
},
{
"path": "content/collections/modifiers/flip.md",
"chars": 525,
"preview": "---\nid: f874e969-d579-4501-9140-e4005945d302\nblueprint: modifiers\nmodifier_types:\n - array\ntitle: Flip\n---\nSwaps the ke"
},
{
"path": "content/collections/modifiers/floor.md",
"chars": 338,
"preview": "---\nid: 0dc57cca-67b2-45a1-a02d-915ac64f064f\nblueprint: modifiers\nmodifier_types:\n - math\n - utility\ntitle: Floor\n---\n"
},
{
"path": "content/collections/modifiers/folder.yaml",
"chars": 60,
"preview": "order: alphabetical\nparse_content: false\ntemplate: modifier\n"
},
{
"path": "content/collections/modifiers/format.md",
"chars": 4678,
"preview": "---\nid: 756d23b4-209c-457c-b9f5-d69347bbe8fe\nblueprint: modifiers\nmodifier_types:\n - date\n - string\ntitle: Format\n---\n"
},
{
"path": "content/collections/modifiers/format_number.md",
"chars": 625,
"preview": "---\nid: 63b56419-6556-4174-8d26-e941460b82a4\nblueprint: modifiers\nmodifier_types:\n - math\n - number\ntitle: 'Format Num"
},
{
"path": "content/collections/modifiers/format_translated.md",
"chars": 884,
"preview": "---\nid: 8cbea367-799f-4fb6-866e-519d571f7b3e\nblueprint: modifiers\nmodifier_types:\n - date\n - string\ntitle: 'Format Tra"
},
{
"path": "content/collections/modifiers/full_urls.md",
"chars": 767,
"preview": "---\nid: 44cb7965-877e-49b3-92fe-a24970b542a2\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: 'Full Ur"
},
{
"path": "content/collections/modifiers/get.md",
"chars": 783,
"preview": "---\nid: c6311d04-364d-4086-8b6b-2a58e88c6cb8\nblueprint: modifiers\ntitle: Get\nmodifier_types:\n - asset\n - utility\n - r"
},
{
"path": "content/collections/modifiers/gravatar.md",
"chars": 607,
"preview": "---\nid: c0a376c1-1ade-447b-8a2d-18722a5446ba\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: Gravatar"
},
{
"path": "content/collections/modifiers/group_by.md",
"chars": 2987,
"preview": "---\nid: a070fabe-c413-4b31-9cb4-ad14bbe1aa4d\nblueprint: modifiers\nmodifier_types:\n - array\ntitle: 'Group By'\n---\n## Ove"
},
{
"path": "content/collections/modifiers/has_lower_case.md",
"chars": 463,
"preview": "---\nid: a5ce6691-840c-4bf7-b5f4-b87bb4845055\nblueprint: modifiers\nmodifier_types:\n - conditions\ntitle: 'Has Lower Case'"
},
{
"path": "content/collections/modifiers/has_upper_case.md",
"chars": 465,
"preview": "---\nid: b2936dd3-f8b1-44a7-bb40-f3b0a8b47e90\nblueprint: modifiers\nmodifier_types:\n - conditions\ntitle: 'Has Upper Case'"
},
{
"path": "content/collections/modifiers/headline.md",
"chars": 934,
"preview": "---\nid: 2d555b32-e68c-4f9b-8570-f2e8d185989b\nblueprint: modifiers\nmodifier_types:\n - markup\n - string\n - utility\ntitl"
},
{
"path": "content/collections/modifiers/hex_to_rgb.md",
"chars": 406,
"preview": "---\nid: 69000ef1-0a98-42a4-ba1a-0bab4c58ca7d\nblueprint: modifiers\nmodifier_types:\n - utility\ntitle: 'Hex To RGB'\n---\nCo"
},
{
"path": "content/collections/modifiers/hours_ago.md",
"chars": 755,
"preview": "---\nid: 6ebb6c28-d1f3-4362-92a0-8a16b5c9cd51\nblueprint: modifiers\nmodifier_types:\n - date\ntitle: 'Hours Ago'\nrelated_en"
},
{
"path": "content/collections/modifiers/image.md",
"chars": 457,
"preview": "---\nid: 26045669-567d-4e93-b3ba-34c835f5c5e9\nblueprint: modifiers\nmodifier_types:\n - asset\n - markup\nattributes: true\n"
},
{
"path": "content/collections/modifiers/in_array.md",
"chars": 1097,
"preview": "---\nid: 4e349523-cba6-4f3b-a0e1-bd4e8b1cf6b9\nblueprint: modifiers\nmodifier_types:\n - array\n - utility\n - conditions\nt"
},
{
"path": "content/collections/modifiers/insert.md",
"chars": 430,
"preview": "---\nid: fa936f49-be25-432e-9543-7a201a652055\nblueprint: modifiers\nmodifier_types:\n - string\n - utility\ntitle: Insert\n-"
},
{
"path": "content/collections/modifiers/is_after.md",
"chars": 975,
"preview": "---\nid: 3c167645-5ad1-45b4-b6df-22b0d2c95abf\nblueprint: modifiers\nmodifier_types:\n - date\n - conditions\ntitle: 'Is Aft"
},
{
"path": "content/collections/modifiers/is_alpha.md",
"chars": 667,
"preview": "---\nid: a6aaac80-19b7-4400-af21-9147aff064c4\nblueprint: modifiers\nmodifier_types:\n - string\n - conditions\ntitle: 'Is A"
},
{
"path": "content/collections/modifiers/is_alphanumeric.md",
"chars": 710,
"preview": "---\nid: 923f34bd-d17d-4353-821f-48e986bdce3b\nblueprint: modifiers\nmodifier_types:\n - number\n - string\n - conditions\nt"
},
{
"path": "content/collections/modifiers/is_array.md",
"chars": 310,
"preview": "---\nid: 1ac30316-8467-425e-9a50-82e754be7df2\nblueprint: modifiers\nmodifier_types:\n - array\n - utility\n - conditions\nt"
},
{
"path": "content/collections/modifiers/is_before.md",
"chars": 984,
"preview": "---\nid: 85b0a5d9-eb77-4bc2-b60e-7b4d3f9aa406\nblueprint: modifiers\nmodifier_types:\n - date\n - conditions\ntitle: 'Is Bef"
},
{
"path": "content/collections/modifiers/is_between.md",
"chars": 796,
"preview": "---\nid: cfbf8926-47ee-42e1-a972-86e3dc13633b\nblueprint: modifiers\nmodifier_types:\n - conditions\n - date\n - number\ntit"
},
{
"path": "content/collections/modifiers/is_blank.md",
"chars": 478,
"preview": "---\nid: 054a230c-a655-48b0-af8b-a963bb0b89b0\nblueprint: modifiers\nmodifier_types:\n - conditions\ntitle: 'Is Blank'\n---\nR"
},
{
"path": "content/collections/modifiers/is_email.md",
"chars": 525,
"preview": "---\nid: 471b3281-4573-43ee-9fee-eb55edf26ad0\nblueprint: modifiers\nmodifier_types:\n - string\n - conditions\ntitle: 'Is E"
}
]
// ... and 739 more files (download for full content)
About this extraction
This page contains the full source code of the statamic/docs GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 939 files (2.4 MB), approximately 670.7k tokens, and a symbol index with 118 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.