tweak the docs for correctness

Author: johnnychen94

docs/quickstart/index.md

@@ -87,7 +87,7 @@ postprocess_cb()
 
 In this example, there are three returned objects from `makedemos`:
 
-* `demopage`: this is the relative path to the generated demos (typically in `src/democards`), you
+* `demopage`: this is the relative path to the generated demos (typically in `src`), you
   can pass it to `makedocs`'s `pages`.
 * `postprocess_cb`: this is the callback function that you'll need to call after `makedocs`.
 * `demo_assets`: if available, it is the path to css file which you could pass to `Documenter.HTML`

docs/quickstart/usage_example/basics/hide_your_card_from_index.md

@@ -10,7 +10,7 @@ There are cases that you want to hide one card in the generated page layout and
 entrance via reflink. For example, you have multiple version of demos and you only want to set the
 latest one as the default and provide legacy versions as reflink in the latest page.
 
-This can be done by setting `hidden: false` in the frontmatter, for example:
+This can be done by setting `hidden: true` in the frontmatter, for example:
 
 ```markdown
 ---

docs/quickstart/usage_example/julia_demos/2.cover_on_the_fly.jl

@@ -30,28 +30,28 @@ cover
 # There are cases that you want to hide the codes related to asset generation, e.g., the
 # `save(...)` line. Fortunately, this is doable by combining the syntax of Documenter and Literate.
 # For example, the following code can be inserted to whereever you need to generate the assets.
-# The [`#src` flag](https://fredrikekre.github.io/Literate.jl/v2/fileformat/#Filtering-Lines) is used as a filter to tell Literate that this line is reserved only in the
-# original source codes.
+# The [`#src` flag](https://fredrikekre.github.io/Literate.jl/v2/fileformat/#Filtering-Lines) is
+# used as a filter to tell Literate that this line is reserved only in the original source codes.
 #
 # ```julia
-# save("assets/cover.png", img_noise) #src
+# save("assets/cover.png", img_noise) #src #md
 # ```
 #
 # Gif image is also supported via `ImageMagick`:
 #
 # ```julia
-# # --- save covers --- #src
-# using ImageMagick #src
-# imgs = map(10:5:50) do k #src
-#     colorview(RGB, rank_approx.(svdfactors, k)...) #src
-# end #src
-# ImageMagick.save("assets/color_separations_svd.gif", cat(imgs...; dims=3); fps=2) #src
+# # --- save covers --- #src #md
+# using ImageMagick #src #md
+# imgs = map(10:5:50) do k #src #md
+#     colorview(RGB, rank_approx.(svdfactors, k)...) #src #md
+# end #src #md
+# ImageMagick.save("assets/color_separations_svd.gif", cat(imgs...; dims=3); fps=2) #src #md
 # ```
 #
 # ### Hide the output result
 # 
 # It does not look good to show the `0` result in the above code block as it does not provide
-# anything that the reader cares.There are two ways to fix this.
+# anything that the reader cares. There are two ways to fix this.
 #
 # The first way is to insert a [`#hide`
 # flag](https://juliadocs.github.io/Documenter.jl/stable/man/syntax/#@example-block) to the line you
@@ -72,14 +72,14 @@ save("assets/lena_color_256.png", cover) #hide
 #
 # ```julia
 # cover = testimage("lena_color_256")
-# save("assets/lena_color_256.png", cover) #hide
+# save("assets/lena_color_256.png", cover) #hide #md
 # nothing #hide #md #md
 # ```
 #
 # generates
 
 cover = testimage("lena_color_256")
-save("assets/lena_color_256.png", cover)
+save("assets/lena_color_256.png", cover) #hide
 nothing #hide #md
 
 # No output at all. You could, of course, insert `cover #hide #md` or others you would like readers
@@ -88,14 +88,14 @@ nothing #hide #md
 #
 # ```julia
 # cover = testimage("lena_color_256")
-# save("assets/lena_color_256.png", cover) #hide
+# save("assets/lena_color_256.png", cover) #hide #md #md
 # cover #hide #md #md
 # ```
 #
 # generates
 
 cover = testimage("lena_color_256")
-save("assets/lena_color_256.png", cover) #hide
+save("assets/lena_color_256.png", cover) #hide #md
 cover #hide #md
 
 # The `#md` flag is used to keep a clean `.jl` file provided by the download-julia badge:

src/generate.jl

@@ -49,7 +49,7 @@ Processing pipeline:
 The following is the simplest example for you to start with:
 
 ```julia
-# 1. preprocess and generate demo files to docs/src/democards
+# 1. preprocess and generate demo files to docs/src
 examples, postprocess_cb, demo_assets = makedemos("examples")
 
 assets = []
@@ -430,7 +430,7 @@ function get_source_url(build_url, source, cardname, src)
     #   - build_dir:            "$build_root/$prefix/$page/$section/$subsection"
     #   - build_url:            "$build_dir/$cardfile"
     # example of build_url:
-    #  "https://github.com/johnnychen94/DemoCards.jl/blob/master/docs/src/democards/quickstart/usage_example/julia_demos/2.cover_on_the_fly.md"
+    #  "https://github.com/johnnychen94/DemoCards.jl/blob/master/docs/src/quickstart/usage_example/julia_demos/2.cover_on_the_fly.md"
     # we need to generate:
     #   - src_root:             "$projct_root/$docs_root/$src"
     #   - src_dir:              "$src_root/$prefix/$page/$section/$subsection"