chore(book): adding examples (#300)

* Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * Initial commit for the Logos Handboook * A bit more adds to the book * chore(ci): setup automated CI for book * chore(ci): update branches * fix(ci): remove extra needs * chore(docs): adding brainfuck example * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * chore(docs): adding brainfuck example * Add missing `Debug` error type requirement (#298) * chore(docs): create JSON example * chore(ci): test code examples * chore(docs): scrape examples and autodoc features * Auto stash before rebase of "maciejhirsz/book" * chore(book): typos and styling --------- Co-authored-by: Maciej Hirsz <[email protected]> Co-authored-by: Marcin Wojnarowski <[email protected]>
maciejhirsz · Jun 25, 2023 · d5b25df · d5b25df
1 parent 9244c62
commit d5b25df
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 7 deletions.
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -23,7 +23,7 @@ concurrency:
   group: pages
   cancel-in-progress: true
 
-jobs:
+jobs:  
   # Build job
   build-book:
     runs-on: ubuntu-latest
@@ -34,7 +34,6 @@ jobs:
       uses: peaceiris/actions-mdbook@v1
       with:
         mdbook-version: '0.4.28'
-        # mdbook-version: 'latest'
     - name: Build book
       run: mdbook build book
     - name: Upload artifact

diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md
@@ -1,11 +1,15 @@
 # Summary
 
 + [Intro](./intro.md)
++ [Getting Started](./getting-started.md)
++ [Examples](./examples.md)
+  + [Brainfuck interpreter](./examples/brainfuck.md)
+  + [JSON parser](./examples/json.md)
 + [Attributes](./attributes.md)
   + [`#[logos]`](./attributes/logos.md)
   + [`#[error]`](./attributes/error.md)
   + [`#[token]` and `#[regex]`](./attributes/token_and_regex.md)
 + [Token disambiguation](./token-disambiguation.md)
 + [Using `Extras`](./extras.md)
 + [Using callbacks](./callbacks.md)
-+ [Common regular expressions](./common-regex.md)
++ [Common regular expressions](./common-regex.md)
diff --git a/logos/Cargo.toml b/logos/Cargo.toml
@@ -38,10 +38,6 @@ export_derive = ["logos-derive"]
 name = "brainfuck"
 path = "examples/brainfuck.rs"
 
-[[example]]
-name = "extras"
-path = "examples/extras.rs"
-
 [[example]]
 name = "json"
 path = "examples/json.rs"