Kompletné stránky definované v kóde
Šablóny a Markdown, synchronizované s WordPress jediným príkazom.
Kolekcie zo súborov
Definujte pages.json a nechajte Blockstudio objaviť všetky zdroje v ňom. Vnorené cesty sa zmenia na vnorené stránky, predvolené nastavenia sa použijú pre celú kolekciu a chýbajúce nadradené priečinky sa môžu vytvoriť.
Kolekcie použite na dokumentáciu, znalostné databázy alebo vstupné stránky a externé priečinky pripojte pod prefix cesty pomocou loader.php.
Vedľa pages.json umiestnite layout.php alebo rozloženie vykresľovača, napríklad layout.tsx, aby sa každá stránka kolekcie zobrazila v spoločnom obale s blockstudio_page_tree() pre bočný panel.
{
"collection": "docs",
"title": "Documentation",
"postType": "bs_docs",
"defaults": {
"postStatus": "publish",
"templateLock": "contentOnly"
}
}---
title: Installation
order: 10
---
# Installation
Install Blockstudio from this Markdown page.<?php $current = blockstudio_current_page(); ?>
<main class="docs-layout">
<aside>
<?php foreach (blockstudio_page_tree('docs') as $item) : ?>
<?php $is_current = ($item['post_id'] ?? null) === ($current['post_id'] ?? null); ?>
<a
href="<?php echo esc_url($item['permalink'] ?? '#'); ?>"
<?php echo $is_current ? 'aria-current="page"' : ''; ?>
>
<?php echo esc_html($item['title']); ?>
</a>
<?php endforeach; ?>
</aside>
<article>
<?php echo blockstudio_page_content(); ?>
</article>
</main>Výslovná synchronizácia
Príkaz wp bs pages sync aplikuje zmeny; nezmenené stránky nevyžadujú žiadne zápisy.
Zdroje Markdown
Použite index.md s frontmatter alebo spojte page.json s obsahom Markdown.
Surové Markdown
Stránky zo súborov Markdown sú dostupné na adrese URL plus .md alebo na bežnej adrese URL pri hlavičke Accept: text/markdown, s kanonickým odkazom späť na HTML.
Načítavače kolekcií
Pripojte priečinky s externou dokumentáciou do kolekcie pod prefixom cesty.
Kolekcie webu
pages.json s rozsahom site uplatní spoločné predvolené nastavenia na celý strom stránok a vytvorí jeho zoznam bez zmeny URL adries alebo riadkov príspevkov.
Pomocné funkcie navigácie
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() a blockstudio_page_content() vytvárajú bočné panely, stránkovanie a telo stránky.
Kolekcie a typy príspevkov
Kolekcie môžu registrovať samostatné hierarchické typy príspevkov.
Uzamknutie šablón
Uzamknite stránky alebo jednotlivé bloky pomocou contentOnly, all alebo insert.
Napíšte HTML a získajte bloky
Štandardné prvky, ako sú <h1>, <p> a <ul>, sa mapujú na základné bloky. Pre každý iný názov bloku a úroveň vnorenia použite <block>.
Blockstudio analyzuje celé rozloženia stránok na skutočné, upraviteľné bloky WordPress.
<div>
<h1 blockEditingMode="contentOnly">About Us</h1>
<p>We build tools for WordPress developers.</p>
<img src="/team.jpg" alt="Our team" />
</div>
<block name="core/columns">
<block name="core/column"><h2>Our Mission</h2></block>
<block name="core/column"><h2>Our Stack</h2></block>
</block>Stránky vykresľované komponentmi
Nastavte render v page.json na položku, napríklad page.tsx, a loader data.php; vykresľovač stránky zaregistrovaný vašou témou alebo pluginom vykreslí celú stránku. Synchronizácia uloží jeden blok blockstudio/page a obsah WordPress, napríklad shortcode, zostane na svojom mieste.
Zdroje vrátené vykresľovačom sa spracujú rovnako ako zdroje blokov a vytlačia sa iba raz, takže ich obsahuje aj vopred vykreslená stránka. Samotné blockstudio.dev sa vytvára zo stránok komponentov.
{
"name": "legal-notice",
"title": "Legal Notice",
"slug": "legal-notice",
"postStatus": "publish",
"render": { "entry": "page.tsx", "data": "data.php" }
}add_action(
'blockstudio/pages/renderers',
static function (): void {
Blockstudio\Page_Renderers::register(
'react',
array(
'extensions' => array( 'tsx' ),
'layouts' => array( 'layout.tsx' ),
'render' => 'my_theme_render_page',
)
);
}
);Trasy bez príspevku
Blockstudio\Virtual_Routes::register() poskytuje dokument, za ktorým nestojí žiadny príspevok, napríklad referenciu komponentov alebo katalóg. Pomocou prefix a match obslúži jedna registrácia celú skupinu URL adries a vrátením null prenechá URL vykonanie WordPress.
Trasa sa vykresľuje do výstupnej vyrovnávacej pamäte Blockstudio, takže jej bloky získajú svoje zdroje a výstup Tailwind. Cesty v urls sa zahrnú do zostavení statického predvykreslenia a Virtual_Routes::urls() ich vráti pre mapu stránok.
add_action( 'init', function () {
Blockstudio\Virtual_Routes::register(
'components',
function ( $component, string $rest ) {
get_header();
echo my_component_page( $component );
get_footer();
},
[
'prefix' => true,
'match' => fn ( string $rest ) => '' === $rest ? 'index' : my_component( $rest ),
'title' => fn ( $component ) => my_component_title( $component ),
'urls' => fn () => my_component_paths(),
]
);
} );Synchronizácia podľa vášho pokynu
Súbory stránok menia WordPress iba na váš pokyn. wp bs pages sync aplikuje všetky zmenené zdroje, zachová obsah editora s kľúčmi a odstráni stránky, ktorých súbory chýbajú.
Kontrolné odtlačky zahŕňajú manifesty, načítavače, rozloženia a zdroje, takže nezmenené stránky nevyžadujú žiadne zápisy. Nasadenia volajú Pages::reconcile() a získajú strojovo čitateľnú správu.
# Apply changed sources, keep keyed edits
wp bs pages sync
# Replace managed content from the files
wp bs pages sync --authoritative
# Compare every page and report as JSON
wp bs pages sync --full --format=json$report = Blockstudio\Pages::reconcile();
if (0 === $report['failed']) {
// Once the release is live and verified:
Blockstudio\Pages::store_successful_source_identity(
$report['sourceIdentity']
);
}Bloky s kľúčmi zachovávajú obsah
Pridajte key do ľubovoľného bloku. Pri ďalšej synchronizácii sa v blokoch s kľúčmi zlúčia atribúty šablóny s existujúcim používateľským obsahom, zatiaľ čo bloky bez kľúčov sa nahradia.
Štruktúru môžete meniť medzi nasadeniami, pričom obsah klientov zostane zachovaný.
<h1 key="title">About Us</h1>
<block name="core/cover" key="hero" url="/hero.jpg">
<h2>Welcome to our company</h2>
<p>Edit this content freely.</p>
</block>
<block name="core/columns" key="team">
<block name="core/column"><h3>Our Team</h3></block>
</block>{
"name": "about",
"title": "About Us",
"slug": "about",
"templateLock": "contentOnly"
}Uzamknutie šablón a režimy úprav
"all" bráni zmenám, "contentOnly" uzamkne štruktúru a povolí úpravy textu a "insert" umožní úpravy a zmenu poradia bez pridávania či odstraňovania.
Prepíšte ľubovoľný prvok pomocou blockEditingMode, aby ste mohli vybrané časti uzamknutej stránky upravovať alebo zakázať jednotlivý blok.
<h1>Welcome to Our Product</h1>
<p>The best solution for your needs.</p>
<block name="core/cover" blockEditingMode="disabled" url="/static-banner.jpg">
<p>Promotional banner</p>
</block>
<block name="core/group" blockEditingMode="default">
<h2>Customizable Section</h2>
</block>{
"name": "landing",
"title": "Landing Page",
"slug": "landing",
"templateLock": "contentOnly",
"blockEditingMode": "contentOnly"
}Šablóny Editora stránky zo súborov
Pridajte template.json a šablónu do templates/ alebo part.json do parts/ a vaša bloková téma získa zdroje wp_template a wp_template_part založené na súboroch.
Používajú rovnakú syntax ako stránky. Prispôsobenie v Editore stránky má prednosť, kým ho niekto nevynuluje; potom sa obnoví zdroj zo súboru.
<block name="core/template-part" slug="header" />
<div>
<h1>Welcome</h1>
<block name="core/post-content" />
</div>
<block name="core/template-part" slug="footer" />{
"slug": "front-page",
"title": "Front Page",
"description": "Homepage template"
}{
"slug": "header",
"title": "Header",
"area": "header"
}Vybraný obsah databázy v git
wp bs content pull exportuje povolené príspevky, výrazy, vzťahy a deklarované metadáta do prenosných súborov a push ich použije v inom prostredí. Deklarované odkazy, nadradené položky a vzťahy výrazov sa prenášajú ako stabilné UID.
Príspevky spravované synchronizáciou stránok možno prepojiť s includePageSyncManaged. Ich súbory obsahujú "bodyOwner": "page-sync", takže Content Sync prenáša metadáta, zatiaľ čo synchronizácia stránok zachováva telo.
{
"content": {
"enabled": true,
"id": "default",
"path": "content",
"postTypes": ["team_member"],
"taxonomies": ["category"],
"meta": {
"include": ["_my_*"],
"references": {
"_thumbnail_id": { "kind": "attachment" },
"_related_posts": { "kind": "post", "path": "*" }
}
},
"media": "manifest"
}
}wp bs content pull --dry-run
wp bs content pull
wp bs content status
wp bs content push --dry-run
wp bs content push --prune --yesBloky s kľúčmi
Zachovajte používateľský obsah aj pri vývoji šablón.
Režimy úprav
Nastavte predvolené hodnoty stránky a prepíšte ich pre jednotlivé prvky.
Prepojenia blokov
Prepojte bloky s metadátami príspevku, aby obsah zostal zachovaný aj po synchronizácii.
Šablóny typov príspevkov
templateFor nastaví stránku ako počiatočnú štruktúru blokov pre každý nový príspevok daného typu.
Pripnuté ID príspevkov
postId pri opätovnej synchronizácii obnoví rovnaké ID, aj keď bola stránka odstránená, takže ponuky a odkazy naďalej fungujú.
Kostra stránok a zámky
Hodnota sync: false spolu s Pages::force_sync() vytvorí stránku iba raz, aby ju mohli spravovať editori. Pages::lock() a unlock() zabránia synchronizácii jednej stránky.
Vlastné vykresľovače parsera
Filtre nástroja na tvorbu a vykresľovača zmenia značku bloku na pole blokov bloku tretej strany alebo upravia spôsob zápisu základného bloku.
Mapovanie prvkov
Priraďte prvok HTML k inému bloku, vyberte blok podľa atribútov prvku a presmerujte odseky HTML do poľa obsahu.
Vlastné cesty vyhľadávania
Filtre pridávajú koreňové cesty pre stránky, vzory a šablóny editora webu, napríklad z pluginu.
Logické zdroje vyhľadávania
Ukážky, prekryvné vrstvy a generované témy môžu nástroju Blockstudio poskytnúť zostavený súpis súborov namiesto jedného priečinka témy.
Stabilné odkazy
Deklarované odkazy na príspevky, výrazy a prílohy sa pri načítaní zmenia na prenosné UID a pri odoslaní sa priradia k miestnym ID.
Stav pred odoslaním
wp bs content status uvádza pri každej entite stav unchanged, would-update, missing-db, conflict, locked alebo orphaned a upozorňuje na kľúče meta, ktoré vyzerajú ako tajné údaje.
Overené odosielania s obmedzeným rozsahom
Pred zápisom overí odoslanie celý plán a preskočí uzamknuté entity. –dry-run zobrazí plán a –prune –yes odstráni iba entity tejto množiny obsahu.
Pod kontrolou verzií
Sledujte súbory stránok v Git a nasadzujte ich v rôznych prostrediach.
PHP API
Programovo pristupujte k stromom, potomkom, metadátam, synchronizácii, uzamykaniu a ID.
Oficiálna súprava rozšírení
Prémiové šablóny webov, systémové pokyny pre AI a súkromná komunita Discord. Jednorazový nákup, aktualizácie na celý život.
- 500+ šablón stránok
- Systémové pokyny pre AI
- Doživotné aktualizácie
- Súkromná komunita Discord