From 7b6d24edd8af7f24a1a3f31957f7441f6f4a61a2 Mon Sep 17 00:00:00 2001 From: Cael Date: Fri, 23 Feb 2024 20:01:07 +0800 Subject: [PATCH] docs: reorganize docs files --- .github/workflows/pages.yml | 7 +-- backend/Cargo.lock | 56 +++++++++--------- backend/Cargo.toml | 3 +- {backend/example => docs}/assets/bin/mdbook | Bin .../example => docs}/assets/css/patch.css | 0 {backend/example => docs}/book.toml | 2 +- {backend/example => docs}/src/SUMMARY.md | 0 .../example => docs}/src/for-developers.md | 0 {backend/example => docs}/src/intro.md | 0 .../src/javascript/examples.md | 0 .../example => docs}/src/javascript/intro.md | 0 {backend/example => docs}/src/limitations.md | 0 .../example => docs}/src/python/examples.md | 0 {backend/example => docs}/src/python/intro.md | 0 .../example => docs}/src/python/packages.md | 0 .../src/typescript/examples.md | 0 .../example => docs}/src/typescript/intro.md | 0 {backend/example => docs}/src/usage.md | 14 ++--- 18 files changed, 38 insertions(+), 44 deletions(-) rename {backend/example => docs}/assets/bin/mdbook (100%) rename {backend/example => docs}/assets/css/patch.css (100%) rename {backend/example => docs}/book.toml (96%) rename {backend/example => docs}/src/SUMMARY.md (100%) rename {backend/example => docs}/src/for-developers.md (100%) rename {backend/example => docs}/src/intro.md (100%) rename {backend/example => docs}/src/javascript/examples.md (100%) rename {backend/example => docs}/src/javascript/intro.md (100%) rename {backend/example => docs}/src/limitations.md (100%) rename {backend/example => docs}/src/python/examples.md (100%) rename {backend/example => docs}/src/python/intro.md (100%) rename {backend/example => docs}/src/python/packages.md (100%) rename {backend/example => docs}/src/typescript/examples.md (100%) rename {backend/example => docs}/src/typescript/intro.md (100%) rename {backend/example => docs}/src/usage.md (91%) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index e6177d7..fc74241 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -48,13 +48,12 @@ jobs: - name: Build book run: | - cd backend - chmod u+x example/assets/bin/* && cp example/assets/bin/* /usr/local/bin - cargo build --release && mdbook build example + cargo build --release --manifest-path backend/Cargo.toml + chmod u+x docs/assets/bin/* && cp docs/assets/bin/* /usr/local/bin && mdbook build docs - name: Merge build assets run: | - mv backend/example/book build + mv docs/book build mv frontend/dist build/embed - name: Deploy to github pages diff --git a/backend/Cargo.lock b/backend/Cargo.lock index 45254cf..5829abf 100644 --- a/backend/Cargo.lock +++ b/backend/Cargo.lock @@ -169,9 +169,9 @@ dependencies = [ [[package]] name = "bumpalo" -version = "3.15.1" +version = "3.15.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c764d619ca78fccbf3069b37bd7af92577f044bb15236036662d79b6559f25b7" +checksum = "8ea184aa71bb362a1157c896979544cc23974e08fd265f29ea96b59f0b4a555b" [[package]] name = "byteorder" @@ -206,7 +206,7 @@ dependencies = [ "android-tzdata", "iana-time-zone", "num-traits", - "windows-targets 0.52.0", + "windows-targets 0.52.3", ] [[package]] @@ -1955,7 +1955,7 @@ version = "0.52.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "33ab640c8d7e35bf8ba19b884ba838ceb4fba93a4e8c65a9059d08afcfc683d9" dependencies = [ - "windows-targets 0.52.0", + "windows-targets 0.52.3", ] [[package]] @@ -1973,7 +1973,7 @@ version = "0.52.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "282be5f36a8ce781fad8c8ae18fa3f9beff57ec1b52cb3de0789201425d9a33d" dependencies = [ - "windows-targets 0.52.0", + "windows-targets 0.52.3", ] [[package]] @@ -1993,17 +1993,17 @@ dependencies = [ [[package]] name = "windows-targets" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8a18201040b24831fbb9e4eb208f8892e1f50a37feb53cc7ff887feb8f50e7cd" +checksum = "d380ba1dc7187569a8a9e91ed34b8ccfc33123bbacb8c0aed2d1ad7f3ef2dc5f" dependencies = [ - "windows_aarch64_gnullvm 0.52.0", - "windows_aarch64_msvc 0.52.0", - "windows_i686_gnu 0.52.0", - "windows_i686_msvc 0.52.0", - "windows_x86_64_gnu 0.52.0", - "windows_x86_64_gnullvm 0.52.0", - "windows_x86_64_msvc 0.52.0", + "windows_aarch64_gnullvm 0.52.3", + "windows_aarch64_msvc 0.52.3", + "windows_i686_gnu 0.52.3", + "windows_i686_msvc 0.52.3", + "windows_x86_64_gnu 0.52.3", + "windows_x86_64_gnullvm 0.52.3", + "windows_x86_64_msvc 0.52.3", ] [[package]] @@ -2014,9 +2014,9 @@ checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8" [[package]] name = "windows_aarch64_gnullvm" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cb7764e35d4db8a7921e09562a0304bf2f93e0a51bfccee0bd0bb0b666b015ea" +checksum = "68e5dcfb9413f53afd9c8f86e56a7b4d86d9a2fa26090ea2dc9e40fba56c6ec6" [[package]] name = "windows_aarch64_msvc" @@ -2026,9 +2026,9 @@ checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc" [[package]] name = "windows_aarch64_msvc" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bbaa0368d4f1d2aaefc55b6fcfee13f41544ddf36801e793edbbfd7d7df075ef" +checksum = "8dab469ebbc45798319e69eebf92308e541ce46760b49b18c6b3fe5e8965b30f" [[package]] name = "windows_i686_gnu" @@ -2038,9 +2038,9 @@ checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e" [[package]] name = "windows_i686_gnu" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a28637cb1fa3560a16915793afb20081aba2c92ee8af57b4d5f28e4b3e7df313" +checksum = "2a4e9b6a7cac734a8b4138a4e1044eac3404d8326b6c0f939276560687a033fb" [[package]] name = "windows_i686_msvc" @@ -2050,9 +2050,9 @@ checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406" [[package]] name = "windows_i686_msvc" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ffe5e8e31046ce6230cc7215707b816e339ff4d4d67c65dffa206fd0f7aa7b9a" +checksum = "28b0ec9c422ca95ff34a78755cfa6ad4a51371da2a5ace67500cf7ca5f232c58" [[package]] name = "windows_x86_64_gnu" @@ -2062,9 +2062,9 @@ checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e" [[package]] name = "windows_x86_64_gnu" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3d6fa32db2bc4a2f5abeacf2b69f7992cd09dca97498da74a151a3132c26befd" +checksum = "704131571ba93e89d7cd43482277d6632589b18ecf4468f591fbae0a8b101614" [[package]] name = "windows_x86_64_gnullvm" @@ -2074,9 +2074,9 @@ checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc" [[package]] name = "windows_x86_64_gnullvm" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1a657e1e9d3f514745a572a6846d3c7aa7dbe1658c056ed9c3344c4109a6949e" +checksum = "42079295511643151e98d61c38c0acc444e52dd42ab456f7ccfd5152e8ecf21c" [[package]] name = "windows_x86_64_msvc" @@ -2086,6 +2086,6 @@ checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538" [[package]] name = "windows_x86_64_msvc" -version = "0.52.0" +version = "0.52.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dff9641d1cd4be8d1a070daf9e3773c5f67e78b4d9d42263020c057706765c04" +checksum = "0770833d60a970638e989b3fa9fd2bb1aaadcf88963d1659fd7d9990196ed2d6" diff --git a/backend/Cargo.toml b/backend/Cargo.toml index 5da263a..508d350 100644 --- a/backend/Cargo.toml +++ b/backend/Cargo.toml @@ -4,12 +4,11 @@ version = "0.2.3" edition = "2021" license = "MIT" readme = "../README.md" -exclude = ["example/*"] keywords = ["mdbook", "repl", "plugin", "preprocessor"] authors = ["MR-Addict "] repository = "https://github.com/MR-Addict/mdbook-repl" documentation = "https://mr-addict.github.io/mdbook-repl" -description = "A rust based mdbook preprocessor plugin that allows you to live code in your markdown book." +description = "A rust based mdbook preprocessor that allows you to execute code in your mdbook without any server. Python, Typescript, Javascript etc." [dependencies] clap = "4.5.0" diff --git a/backend/example/assets/bin/mdbook b/docs/assets/bin/mdbook similarity index 100% rename from backend/example/assets/bin/mdbook rename to docs/assets/bin/mdbook diff --git a/backend/example/assets/css/patch.css b/docs/assets/css/patch.css similarity index 100% rename from backend/example/assets/css/patch.css rename to docs/assets/css/patch.css diff --git a/backend/example/book.toml b/docs/book.toml similarity index 96% rename from backend/example/book.toml rename to docs/book.toml index 5de4f4c..9fcb354 100644 --- a/backend/example/book.toml +++ b/docs/book.toml @@ -47,7 +47,7 @@ heading-split-level = 3 copy-js = true [preprocessor.repl] -command = "target/release/mdbook-repl" +command = "backend/target/release/mdbook-repl" # iframe url src = "https://mr-addict.github.io/mdbook-repl/embed/" diff --git a/backend/example/src/SUMMARY.md b/docs/src/SUMMARY.md similarity index 100% rename from backend/example/src/SUMMARY.md rename to docs/src/SUMMARY.md diff --git a/backend/example/src/for-developers.md b/docs/src/for-developers.md similarity index 100% rename from backend/example/src/for-developers.md rename to docs/src/for-developers.md diff --git a/backend/example/src/intro.md b/docs/src/intro.md similarity index 100% rename from backend/example/src/intro.md rename to docs/src/intro.md diff --git a/backend/example/src/javascript/examples.md b/docs/src/javascript/examples.md similarity index 100% rename from backend/example/src/javascript/examples.md rename to docs/src/javascript/examples.md diff --git a/backend/example/src/javascript/intro.md b/docs/src/javascript/intro.md similarity index 100% rename from backend/example/src/javascript/intro.md rename to docs/src/javascript/intro.md diff --git a/backend/example/src/limitations.md b/docs/src/limitations.md similarity index 100% rename from backend/example/src/limitations.md rename to docs/src/limitations.md diff --git a/backend/example/src/python/examples.md b/docs/src/python/examples.md similarity index 100% rename from backend/example/src/python/examples.md rename to docs/src/python/examples.md diff --git a/backend/example/src/python/intro.md b/docs/src/python/intro.md similarity index 100% rename from backend/example/src/python/intro.md rename to docs/src/python/intro.md diff --git a/backend/example/src/python/packages.md b/docs/src/python/packages.md similarity index 100% rename from backend/example/src/python/packages.md rename to docs/src/python/packages.md diff --git a/backend/example/src/typescript/examples.md b/docs/src/typescript/examples.md similarity index 100% rename from backend/example/src/typescript/examples.md rename to docs/src/typescript/examples.md diff --git a/backend/example/src/typescript/intro.md b/docs/src/typescript/intro.md similarity index 100% rename from backend/example/src/typescript/intro.md rename to docs/src/typescript/intro.md diff --git a/backend/example/src/usage.md b/docs/src/usage.md similarity index 91% rename from backend/example/src/usage.md rename to docs/src/usage.md index 7275bff..fb4f885 100644 --- a/backend/example/src/usage.md +++ b/docs/src/usage.md @@ -1,6 +1,6 @@ # Usage -This preprocessor is designed to be used with [mdbook](https://rust-lang.github.io/mdBook). If you want to use this repl in your own web project other thatn mdbook, you can have a look at [For Developers](for-developers.md) section. +This preprocessor is designed to be used with [mdbook](https://rust-lang.github.io/mdBook). If you want to use this repl in your own web project other than mdbook, you can have a look at [For Developers](for-developers.md) section. ## Installation @@ -82,13 +82,11 @@ Here is the full list of extensions: You can also specific some options for the each codeblock. For example, you can specify the **readonly** for the codeblock: -

-```javascript,readonly
+
```javascript,readonly
 // javascript codeblock
 
 console.log("Hello, world!");
-```
-

+```
And the codeblock will not be eidtable: @@ -100,13 +98,11 @@ console.log("Hello, world!"); If you put **norepl** option in the codeblock: -

-```javascript,norepl
+
```javascript,norepl
 // javascript codeblock
 
 console.log("Hello, world!");
-```
-

+```
And it will not be rendered by this preprocessor: