Update from upstream

.cargo/config.toml

@@ -0,0 +1,3 @@
+[alias]
+# xtask = "run --package xtask --bin xtask --"
+md-test = "run --package xtask --bin xtask"

.github/FUNDING.yml

@@ -0,0 +1 @@
+github: veykril

.github/workflows/gh-pages.yml

@@ -1,28 +1,36 @@
 name: github pages
 
 on:
+  pull_request:
   push:
     branches:
       - master
 
 jobs:
   deploy:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Clone repository
+        uses: actions/checkout@v3
 
       - name: Setup mdBook
         uses: peaceiris/actions-mdbook@v1
         with:
           mdbook-version: 'latest'
 
-      - run: mdbook build
+      - name: Build
+        run: mdbook build
+
+      - name: Test
+        run: mdbook test
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./book
+          publish_dir: ./book/html
           force_orphan: true
           user_name: 'github-actions[bot]'
-          user_email: 'github-actions[bot]@users.noreply.github.com'
+          user_email: 'github-actions[bot]@users.noreply.github.com'
+        # Only deploy on a push to master, not on a pull request.
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository == 'Veykril/tlborm'

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+# Style
+
+Prefer a sentence-per-line format.

README.md

@@ -1,35 +1,29 @@
 # The Little Book of Rust Macros
 
-> **Note**: This is a continuation of [Daniel Keep's Book](https://github.com/DanielKeep/tlborm)
-> which has not been updated since the early summer of 2016, adapted to make use of
-> [mdBook](https://github.com/rust-lang/mdBook).
-
-View the [rendered version here](https://veykril.github.io/tlborm/) and the
-[repository here](https://github.com/veykril/tlborm).
-
-This book is an attempt to distill the Rust community's collective knowledge of Rust macros,
-`Macros by Example` to be precise.  As such, both additions (in the form of pull requests) and
-requests (in the form of issues) are welcome.
-The [original Little Book of Rust Macros](https://github.com/DanielKeep/tlborm) has helped me
-immensely with understanding ***Macros by Example*** style macros while I was still learning the
-language. Unfortunately, the author of the book has since left the project untouched, while the Rust
-language as well as it's macro-system keeps evolving. Which is why I wanted to revive the project
-and keep it up to date with current Rust helping other newcomers understand macros, a part of the
-language a lot of people seem to have trouble with.
-
-> This book expects you to have basic knowledge of Rust, it will not explain language features or
-> constructs that are irrelevant to macros. No prior knowledge of macros is assumed. Having read and
-> understood the first seven chapters of the [Rust Book](https://doc.rust-lang.org/stable/book/) is
-> a must, though having read the majority of the book is recommended.
+> **Note**: This is a continuation of [Daniel Keep's Book](https://github.com/DanielKeep/tlborm) which has not been updated since the early summer of 2016, adapted to make use of [mdBook](https://github.com/rust-lang/mdBook).
+
+View the [rendered version here](https://veykril.github.io/tlborm/) and the [repository here](https://github.com/veykril/tlborm).
+
+A chinese version of this book can be found [here](https://zjp-cn.github.io/tlborm/).
+
+This book is an attempt to distill the Rust community's collective knowledge of Rust macros, the `Macros by Example` ones as well as procedural macros(WIP).
+As such, both additions (in the form of pull requests) and requests (in the form of issues) are very much welcome.
+If something's unclear, opens up questions or is not understandable as written down, fear not to make an issue asking for clarification.
+The goal is for this book to become the best learning resource possible.
+
+The [original Little Book of Rust Macros](https://github.com/DanielKeep/tlborm) has helped me immensely with understanding ***Macros by Example*** style macros while I was still learning the language.
+Unfortunately, the original book hasn't been updated since April of 2016, while the Rust language as well as its macro-system keeps evolving.
+Which is why I took up the task to update the book and keep it updated as well as I can while also adding newfound things to it.
+In hopes that it will help out all the fresh faces coming to Rust understanding its macro systems, a part of the language a people tend to have trouble with.
+
+> This book expects you to have basic knowledge of Rust, it will not explain language features or constructs that are irrelevant to macros.
+> No prior knowledge of macros is assumed.
+> Having read and understood the first seven chapters of the [Rust Book](https://doc.rust-lang.org/stable/book/) is a must, though having read the majority of the book is recommended.
 
 ## Thanks
 
-Thanks to Daniel Keep for the original work and thanks to the following people for suggestions and
-corrections to the original: IcyFoxy, Rym, TheMicroWorm, Yurume, akavel, cmr, eddyb, ogham, and
-snake_case.
+A big thank you to Daniel Keep for the original work as well as all the contributors that added to the original which can be found [here](https://github.com/DanielKeep/tlborm).
 
 ## License
 
-This work inherits the licenses of the original, hence it is licensed under both the
-[Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/)
-and the [MIT license](http://opensource.org/licenses/MIT).
+This work inherits the licenses of the original, hence it is licensed under both the [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/) and the [MIT license](http://opensource.org/licenses/MIT).

book.toml

@@ -4,14 +4,48 @@ language = "en"
 multilingual = false
 src = "src"
 title = "The Little Book of Rust Macros"
+edition = "2018"
 
 [build]
 create-missing = true
 build-dir = "book"
 
+[output.linkcheck]
+traverse-parent-directories = false
+optional = true
+
 [output.html]
 default-theme = "ayu"
 site-url = "/tlborm/"
 mathjax-support = true
 git-repository-url = "https://github.com/veykril/tlborm/"
-additional-css = ["res/rust-syntax-bg-highlight.css"]
+additional-css = ["res/rust-syntax-bg-highlight.css"]
+
+[output.html.fold]
+enable = true
+level = 1
+
+[output.html.redirect]
+"/building-blocks/abacus-counting.html" = "../decl-macros/building-blocks/abacus-counting.html"
+"/building-blocks/ast-coercion.html" = "../decl-macros/building-blocks/ast-coercion.html"
+"/building-blocks/counting.html" = "../decl-macros/building-blocks/counting.html"
+"/building-blocks/parsing.html" = "../decl-macros/building-blocks/parsing.html"
+
+"/macros-practical.html" = "./decl-macros/macros-practical.html"
+"/patterns.html" = "./decl-macros/patterns.html"
+"/building-blocks.html" = "./decl-macros/building-blocks.html"
+
+"/patterns/callbacks.html" = "../decl-macros/patterns/callbacks.html"
+"/patterns/internal-rules.html" = "../decl-macros/patterns/internal-rules.html"
+"/patterns/push-down-acc.html" = "../decl-macros/patterns/push-down-acc.html"
+"/patterns/repetition-placement.html" = "../decl-macros/patterns/repetition-placement.html"
+"/patterns/tt-bundling.html" = "../decl-macros/patterns/tt-bundling.html"
+"/patterns/tt-muncher.html" = "../decl-macros/patterns/tt-muncher.html"
+
+"/decl-macros/syntax/ast.html" = "../../syntax-extensions/ast.html"
+"/decl-macros/syntax/expansion.html" = "../../syntax-extensions/expansion.html"
+"/decl-macros/syntax/source-analysis.html" = "../../syntax-extensions/source-analysis.html"
+
+[rust]
+# see: https://rust-lang.github.io/mdBook/format/configuration/general.html#rust-options
+edition = "2021"

res/rust-syntax-bg-highlight.css

@@ -1,36 +1,6 @@
-/**
- * Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
- * file at the top-level directory of this distribution and at
- * http://rust-lang.org/COPYRIGHT.
- * With elements taken from Bootstrap v3.0.2 (MIT licensed).
- *
- * Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
- * http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
- * <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
- * option. This file may not be copied, modified, or distributed
- * except according to those terms.
- *
- * Modified by Daniel Keep.
- */
-
-
-/* Code highlighting */
-pre.rust .kw { color: #f92672; }
-pre.rust .kw-2 { color: #f92672; }
-pre.rust .prelude-ty { color: #66d9ef; }
-pre.rust .number { color: #EFD6AB; }
-pre.rust .string { color: #F8E9A5; }
-pre.rust .self { color: #f92672; }
-pre.rust .boolval { color: #EFD6AB; }
-pre.rust .prelude-val { color: #66d9ef; }
-pre.rust .attribute { color: #C7AFD1; }
-pre.rust .attribute .ident { color: #D4BBDE; }
-pre.rust .comment { color: #75715e; }
-pre.rust .doccomment { color: #75715e; }
-pre.rust .macro { color: #AC7FE7; }
-pre.rust .macro-nonterminal { color: #CFC0E2; }
-pre.rust .lifetime { color: #B76514; }
-pre.rust .op { color: #f92672; }
-
 pre.rust .synctx-0 { background-color: rgba(255, 0, 0, 0.1); }
 pre.rust .synctx-1 { background-color: rgba(0, 255, 0, 0.1); }
+.light pre.rust .synctx-0 { background-color: rgba(255, 0, 0, 0.2); }
+.light pre.rust .synctx-1 { background-color: rgba(0, 255, 0, 0.2); }
+.rust pre.rust .synctx-0 { background-color: rgba(255, 0, 0, 0.2); }
+.rust pre.rust .synctx-1 { background-color: rgba(0, 255, 0, 0.2); }

src/SUMMARY.md

@@ -2,30 +2,49 @@
 
 [Introduction](./introduction.md)
 
-- [Macros, A Methodical Introduction](./macros.md)
-    - [Syntax Extensions](./macros/syntax.md)
-        - [Source Analysis](./macros/syntax/source-analysys.md)
-        - [Macros in the Ast](./macros/syntax/ast.md)
-        - [Expansion](./macros/syntax/expansion.md)
-    - [macro_rules!](./macros/macro_rules.md)
-    - [Minutiae](./macros/minutiae.md)
-        - [Fragment Specifiers](./macros/minutiae/fragment-specifiers.md)
-        - [Metavariables and Expansion Redux](./macros/minutiae/metavar-and-expansion.md)
-        - [Hygiene](./macros/minutiae/hygiene.md)
-        - [Non-Identifier Identifiers](./macros/minutiae/identifiers.md)
-        - [Debugging](./macros/minutiae/debugging.md)
-        - [Scoping](./macros/minutiae/scoping.md)
-        - [Import and Export](./macros/minutiae/import-export.md)
-- [Macros, A Practical Introduction](./macros-practical.md)
-- [Patterns](./patterns.md)
-    - [Callbacks](./patterns/callbacks.md)
-    - [Incremental TT Munchers](./patterns/tt-muncher.md)
-    - [Internal Rules](./patterns/internal-rules.md)
-    - [Push-down Accumulation](./patterns/push-down-acc.md)
-    - [Repetition Replacement](./patterns/repetition-replacement.md)
-    - [TT Bundling](./patterns/tt-bundling.md)
-- [Building Blocks](./building-blocks.md)
-    - [AST Coercion](./building-blocks/ast-coercion.md)
-    - [Counting](./building-blocks/counting.md)
-        - [Abacus Counting](./building-blocks/abacus-counting.md)
-    - [Parsing Rust](./building-blocks/parsing.md)
+- [Syntax Extensions](./syntax-extensions.md)
+    - [Source Analysis](./syntax-extensions/source-analysis.md)
+    - [Macros in the Ast](./syntax-extensions/ast.md)
+    - [Expansion](./syntax-extensions/expansion.md)
+    - [Hygiene](./syntax-extensions/hygiene.md)
+    - [Debugging](./syntax-extensions/debugging.md)
+- [Declarative Macros](./decl-macros.md)
+    - [A Methodical Introduction](./decl-macros/macros-methodical.md)
+    - [A Practical Introduction](./decl-macros/macros-practical.md)
+    - [Minutiae](./decl-macros/minutiae.md)
+        - [Fragment Specifiers](./decl-macros/minutiae/fragment-specifiers.md)
+        - [Metavariables and Expansion Redux](./decl-macros/minutiae/metavar-and-expansion.md)
+        - [Metavariable Expressions](./decl-macros/minutiae/metavar-expr.md)
+        - [Hygiene](./decl-macros/minutiae/hygiene.md)
+        - [Non-Identifier Identifiers](./decl-macros/minutiae/identifiers.md)
+        - [Debugging](./decl-macros/minutiae/debugging.md)
+        - [Scoping](./decl-macros/minutiae/scoping.md)
+        - [Import and Export](./decl-macros/minutiae/import-export.md)
+    - [Patterns](./decl-macros/patterns.md)
+        - [Callbacks](./decl-macros/patterns/callbacks.md)
+        - [Incremental TT Munchers](./decl-macros/patterns/tt-muncher.md)
+        - [Internal Rules](./decl-macros/patterns/internal-rules.md)
+        - [Push-down Accumulation](./decl-macros/patterns/push-down-acc.md)
+        - [Repetition Replacement](./decl-macros/patterns/repetition-replacement.md)
+        - [TT Bundling](./decl-macros/patterns/tt-bundling.md)
+    - [Building Blocks](./decl-macros/building-blocks.md)
+        - [AST Coercion](./decl-macros/building-blocks/ast-coercion.md)
+        - [Counting](./decl-macros/building-blocks/counting.md)
+            - [Abacus Counting](./decl-macros/building-blocks/abacus-counting.md)
+        - [Parsing Rust](./decl-macros/building-blocks/parsing.md)
+    - [Macros 2.0](./decl-macros/macros2.md)
+ - [Procedural Macros](./proc-macros.md)
+    - [A Methodical Introduction](./proc-macros/methodical.md)
+        - [Function-like](./proc-macros/methodical/function-like.md)
+        - [Attribute](./proc-macros/methodical/attr.md)
+        - [Derive](./proc-macros/methodical/derive.md)
+    - [A Practical Introduction]()<!-- ./proc-macros/practical.md -->
+        - [Function-like]()<!-- ./proc-macros/practical/function-like.md -->
+        - [Attribute]()<!-- ./proc-macros/practical/attr.md -->
+        - [Derive]()<!-- ./proc-macros/practical/derive.md -->
+    - [Third-Party Crates](./proc-macros/third-party-crates.md)
+    - [Hygiene and Spans](./proc-macros/hygiene.md)
+    - [Techniques]()<!-- ./proc-macros/techniques.md -->
+        - [Testing]()<!-- ./proc-macros/techniques/testing.md -->
+
+ [Glossary](./glossary.md)