Celotne strani, določene v kodi
Predloge in Markdown, sinhronizirani z WordPress z enim ukazom.
Zbirke iz datotek
Določite pages.json in dovolite, da Blockstudio odkrije vse vire pod njim. Ugnezdene poti postanejo ugnezdene strani, privzete nastavitve veljajo za zbirko, manjkajoče nadrejene strani pa je mogoče ustvariti.
Zbirke uporabite za dokumentacijo, baze znanja ali ciljne strani, zunanje mape pa namestite pod predpono poti z loader.php.
Zraven pages.json postavite layout.php ali postavitev izrisovalnika, kot je layout.tsx, da vsako stran zbirke ovijete v eno ogrodje, za stransko vrstico pa uporabite blockstudio_page_tree().
{
"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>Izrecna sinhronizacija
wp bs pages sync uveljavi spremembe; nespremenjene strani ne zahtevajo nobenega zapisovanja.
Viri Markdown
Uporabite index.md z uvodnimi metapodatki ali združite page.json z vsebino Markdown.
Neobdelani Markdown
Strani datotek Markdown so na voljo na svojem URL z dodatkom .md ali na običajnem URL za Accept: text/markdown, s kanonično povezavo nazaj na HTML.
Nalagalniki zbirk
Namestite mape z zunanjo dokumentacijo v zbirko pod predpono poti.
Zbirke spletnega mesta
pages.json z obsegom site uporabi skupne privzete nastavitve za celotno drevo strani in ga navede, ne da bi spreminjal URL-je ali vrstice objav.
Pomožne funkcije za krmarjenje
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() in blockstudio_page_content() sestavijo stranske vrstice, straničenje in telo.
Zbirke in vrste objav
Zbirke lahko registrirajo namenske hierarhične vrste objav.
Zaklepanje predlog
Zaklenite strani ali posamezne bloke z contentOnly, all ali insert.
Pišite HTML, ustvarite bloke
Standardni elementi, kot so <h1>, <p> in <ul>, se preslikajo v osnovne bloke. Za vsa druga imena blokov in ravni gnezdenja uporabite <block>.
Blockstudio razčleni celotne postavitve strani v prave, urejevalne bloke 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>Strani, izrisane s komponentami
V page.json nastavite render na vnos, kot je page.tsx, in nalagalnik data.php; nato izrisovalnik strani, ki ga registrira vaša tema ali vtičnik, nariše celotno stran. Sinhronizacija shrani en blok blockstudio/page, vsebina WordPress, kot je kratka koda, pa ostane v svojem mestu.
Sredstva, ki jih vrne izrisovalnik, se obdelajo enako kot sredstva blokov in se izpišejo enkrat, zato jih vnaprej izrisana stran vsebuje. Tudi blockstudio.dev je zgrajen iz komponentnih strani.
{
"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',
)
);
}
);Poti brez objave
Blockstudio\Virtual_Routes::register() streže dokument, za katerim ni objave, na primer referenco komponent ali katalog. Z prefix in match en sam vpis pokrije celo skupino URL-jev, vrnitev null pa prepusti URL orodju WordPress.
Pot se izriše v izhodnem medpomnilniku Blockstudio, zato njeni bloki dobijo svoja sredstva in izhod Tailwind. Poti v urls se vključijo v gradnje s statičnim vnaprejšnjim izrisom, Virtual_Routes::urls() pa jih vrne za zemljevid mesta.
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(),
]
);
} );Sinhronizirajte po svoji izbiri
Datoteke strani se spremenijo v WordPress samo, ko to zahtevate. wp bs pages sync uveljavi vse spremenjene vire, ohrani vsebino blokov s ključi in odstrani strani, katerih datotek ni več.
Prstni odtisi zajemajo manifeste, nalagalnike, postavitve in vire, zato nespremenjene strani ne zahtevajo nobenega zapisovanja. Uvedbe pokličejo Pages::reconcile() in prejmejo strojno berljivo poročilo.
# 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']
);
}Bloki s ključi ohranijo vsebino
V kateri koli blok dodajte key. Ob naslednji sinhronizaciji se atributi predloge pri blokih s ključi združijo z obstoječo uporabniško vsebino, bloki brez ključev pa se zamenjajo.
Med uvedbami spreminjajte strukturo, vsebina strank pa ostane nedotaknjena.
<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"
}Zaklepanje predlog in načini urejanja
"all" prepreči spremembe, "contentOnly" zaklene strukturo in dovoli urejanje besedila, "insert" pa dovoli urejanje in spreminjanje vrstnega reda brez dodajanja ali odstranjevanja.
Kateri koli element preglasite z blockEditingMode, da zaklenjeno stran po potrebi omogočite za urejanje ali onemogočite posamezen 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"
}Predloge urejevalnika spletnega mesta iz datotek
Dodajte template.json in predlogo v templates/ ali pa part.json v parts/, da bo vaša blokovna tema pridobila vire wp_template in wp_template_part iz datotek.
Uporabljajo isto sintakso kot strani. Prilagoditev v urejevalniku spletnega mesta ima še vedno prednost, dokler je kdo ne ponastavi; takrat se znova uporabi vir iz datoteke.
<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"
}Izbrana vsebina zbirke podatkov v git
wp bs content pull izvozi objave, izraze, relacije in deklarirane metapodatke z dovoljenega seznama v prenosljive datoteke, push pa jih uvozi v drugo okolje. Deklarirane reference, nadrejeni elementi in relacije izrazov se prenesejo kot stabilni UID-ji.
Objave, upravljane s sinhronizacijo strani, se lahko povežejo z includePageSyncManaged. Njihove datoteke vsebujejo "bodyOwner": "page-sync", zato Content Sync prenese metapodatke, sinhronizacija strani pa ohrani 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 --yesBloki s ključi
Ohranite uporabniško vsebino, medtem ko se predloge spreminjajo.
Načini urejanja
Nastavite privzete možnosti strani in preglasite posamezne elemente.
Povezave blokov
Povežite bloke z metapodatki objav, da se vsebina ohrani pri sinhronizaciji.
Predloge za vrste objav
templateFor določi stran kot začetno strukturo blokov za vsako novo objavo določene vrste.
ID-ji pripetih objav
postId ob ponovni sinhronizaciji znova dodeli isti ID, če je bila stran izbrisana, zato meniji in povezave še naprej delujejo.
Ogrodja in zaklepi
sync: false skupaj z Pages::force_sync() ustvari stran enkrat, da jo uredniki upravljajo. Pages::lock() in unlock() preprečita sinhronizacijo posamezne strani.
Izrisovalniki razčlenjevalnikov po meri
Filtri za graditelja in izrisovalnik pretvorijo oznako bloka v polje blokov bloka drugega ponudnika ali spremenijo zapis jedrnega bloka.
Preslikava elementov
Preslikajte element HTML v drug blok, izberite blok glede na atribute elementa in usmerite HTML odstavka v polje vsebine.
Poti za odkrivanje po meri
Filtri dodajo korenske poti za strani, vzorce in predloge urejevalnika spletnega mesta, na primer iz vtičnika.
Logični viri za odkrivanje
Predogledi, prekrivni elementi in ustvarjene teme lahko orodju Blockstudio posredujejo sestavljen popis datotek namesto ene mape teme.
Stabilne reference
Navedene reference na objave, izraze in priloge se pri prenosu spremenijo v prenosljive UID-je, pri pošiljanju pa se razrešijo v lokalne ID-je.
Stanje pred pošiljanjem
wp bs content status vsako entiteto označi kot nespremenjeno, bi bila posodobljena, manjka v zbirki podatkov, v sporu, zaklenjeno ali osirotelo ter opozori na ključe metapodatkov, ki so videti kot skrivnosti.
Preverjena pošiljanja z omejenim obsegom
Pred pisanjem pošiljanje preveri celoten načrt in preskoči zaklenjene entitete. –dry-run prikaže načrt, –prune –yes pa odstrani samo entitete tega nabora vsebine.
Pod nadzorom različic
Spremljajte datoteke strani v Git in jih uvajajte v različnih okoljih.
PHP API
Do dreves, podrejenih elementov, metapodatkov, sinhronizacije, zaklepanja in ID-jev dostopajte programsko.
Uradni komplet razširitev
Vrhunske predloge spletnih mest, sistemska navodila za UI in zasebna skupnost Discord. Enkratni nakup, posodobitve za vedno.
- Več kot 500+ predlog spletnih mest
- Sistemska navodila za UI
- Doživljenjske posodobitve
- Zasebna skupnost Discord