Fix the URL's in the docs (#637)

* Add template directory and copy the replaced markdown files to the tutorials directory.

* Format code

* Replace strings of file paths with joinpath()

---------

Co-authored-by: Erik Faulhaber <[email protected]>

Author: RubberLanding

.gitignore

@@ -9,6 +9,7 @@ docs/src/contributing.md
 docs/src/license.md
 docs/src/code_of_conduct.md
 docs/src/news.md
+docs/src/tutorials
 *_replaced.md
 run
 *.json

docs/make.jl

@@ -61,16 +61,23 @@ function replace_with_code(filename)
         end
     end
 
+    # Check if tutorials directory exists, else create one
+    path_tutorials = joinpath("docs", "src", "tutorials")
+    if !isdir(path_tutorials)
+        mkdir(path_tutorials)
+    end
+
+    file_basename = basename(filename)
+
     # Replace all occurrences in the markdown content
-    filename_noext, extension = splitext(filename)
-    copy_file(filename, new_file="$(filename_noext)_replaced$extension",
+    copy_file(filename, new_file=joinpath(path_tutorials, file_basename),
               pattern => replace_include)
 end
 
-replace_with_code("docs/src/tutorials/tut_setup.md")
-replace_with_code("docs/src/tutorials/tut_dam_break.md")
-replace_with_code("docs/src/tutorials/tut_beam.md")
-replace_with_code("docs/src/tutorials/tut_falling.md")
+replace_with_code(joinpath("docs", "src", "tutorials_template", "tut_setup.md"))
+replace_with_code(joinpath("docs", "src", "tutorials_template", "tut_dam_break.md"))
+replace_with_code(joinpath("docs", "src", "tutorials_template", "tut_beam.md"))
+replace_with_code(joinpath("docs", "src", "tutorials_template", "tut_falling.md"))
 
 copy_file("AUTHORS.md",
           "in the [LICENSE.md](LICENSE.md) file" => "under [License](@ref)")

docs/src/tutorial.md

@@ -2,12 +2,12 @@
 
 
 ## Fluid
-- [Setting up your simulation from scratch](tutorials/tut_setup_replaced.md)
-- [Setting up a dam break simulation](tutorials/tut_dam_break_replaced.md)
+- [Setting up your simulation from scratch](tutorials/tut_setup.md)
+- [Setting up a dam break simulation](tutorials/tut_dam_break.md)
 
 ## Mechanics
-- [Deforming a beam](tutorials/tut_beam_replaced.md)
+- [Deforming a beam](tutorials/tut_beam.md)
 
 
 ## Fluid-Structure Interaction
-- [Setting up a falling structure](tutorials/tut_falling_replaced.md)
+- [Setting up a falling structure](tutorials/tut_falling.md)