docs: reorganize docs files

MR-Addict · Feb 23, 2024 · 7b6d24e · 7b6d24e
1 parent b388c0e
commit 7b6d24e
Show file tree

Hide file tree

Showing 18 changed files with 38 additions and 44 deletions.
diff --git 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
diff --git 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 <MR-Addict@qq.com>"]
 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 → docs/assets/bin/mdbook b/backend/example/assets/bin/mdbook → docs/assets/bin/mdbook
diff --git a/backend/example/assets/css/patch.css → docs/assets/css/patch.css b/backend/example/assets/css/patch.css → docs/assets/css/patch.css
diff --git a/backend/example/book.toml → docs/book.toml b/backend/example/book.toml → 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 → docs/src/SUMMARY.md b/backend/example/src/SUMMARY.md → docs/src/SUMMARY.md
diff --git a/backend/example/src/for-developers.md → docs/src/for-developers.md b/backend/example/src/for-developers.md → docs/src/for-developers.md
diff --git a/backend/example/src/intro.md → docs/src/intro.md b/backend/example/src/intro.md → docs/src/intro.md
diff --git a/backend/example/src/javascript/examples.md → docs/src/javascript/examples.md b/backend/example/src/javascript/examples.md → docs/src/javascript/examples.md
diff --git a/backend/example/src/javascript/intro.md → docs/src/javascript/intro.md b/backend/example/src/javascript/intro.md → docs/src/javascript/intro.md
diff --git a/backend/example/src/limitations.md → docs/src/limitations.md b/backend/example/src/limitations.md → docs/src/limitations.md
diff --git a/backend/example/src/python/examples.md → docs/src/python/examples.md b/backend/example/src/python/examples.md → docs/src/python/examples.md
diff --git a/backend/example/src/python/intro.md → docs/src/python/intro.md b/backend/example/src/python/intro.md → docs/src/python/intro.md
diff --git a/backend/example/src/python/packages.md → docs/src/python/packages.md b/backend/example/src/python/packages.md → docs/src/python/packages.md
diff --git a/backend/example/src/typescript/examples.md → docs/src/typescript/examples.md b/backend/example/src/typescript/examples.md → docs/src/typescript/examples.md
diff --git a/backend/example/src/typescript/intro.md → docs/src/typescript/intro.md b/backend/example/src/typescript/intro.md → docs/src/typescript/intro.md
diff --git a/backend/example/src/usage.md → docs/src/usage.md b/backend/example/src/usage.md → 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:
 
-<pre><code>
-&#96;&#96;&#96;javascript,readonly
+<pre><code class="language-markdown">&#96;&#96;&#96;javascript,readonly
 // javascript codeblock
 
 console.log("Hello, world!");
-&#96;&#96;&#96;
-</code></pre>
+&#96;&#96;&#96;</code></pre>
 
 And the codeblock will not be eidtable:
 
@@ -100,13 +98,11 @@ console.log("Hello, world!");
 
 If you put **norepl** option in the codeblock:
 
-<pre><code>
-&#96;&#96;&#96;javascript,norepl
+<pre><code class="language-markdown">&#96;&#96;&#96;javascript,norepl
 // javascript codeblock
 
 console.log("Hello, world!");
-&#96;&#96;&#96;
-</code></pre>
+&#96;&#96;&#96;</code></pre>
 
 And it will not be rendered by this preprocessor: