docs: ✏️ Change prettyurls and use LiveServer for docs

copier.yml

@@ -7,6 +7,7 @@ PackageUUID:
   type: str
   help: UUID v4 (Generate this with uuidgen or in Julia with `using UUIDs; uuid4()`)
   validator: "{% if PackageUUID | length == 0 %}Can't be empty{% endif %}"
+  default: "{{ 999999999999999999999999999999999 | ans_random | to_uuid }}"
 
 PackageOwner:
   type: str

docs/make.jl

@@ -21,7 +21,7 @@ makedocs(;
   repo = "https://github.com/abelsiqueira/COPIERTemplate.jl/blob/{commit}{path}#{line}",
   sitename = "COPIERTemplate.jl",
   format = Documenter.HTML(;
-    prettyurls = get(ENV, "CI", "false") == "true",
+    prettyurls = true,
     canonical = "https://abelsiqueira.github.io/COPIERTemplate.jl",
     assets = ["assets/style.css"],
   ),

template/docs/Project.toml.jinja

@@ -4,6 +4,7 @@
 #
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 {{ PackageName }} = "{{ PackageUUID }}"
 
 [compat]

template/docs/make.jl.jinja

@@ -21,7 +21,7 @@ makedocs(;
   repo = "https://github.com/{{ PackageOwner }}/{{ PackageName }}.jl/blob/{commit}{path}#{line}",
   sitename = "{{ PackageName }}.jl",
   format = Documenter.HTML(;
-    prettyurls = get(ENV, "CI", "false") == "true",
+    prettyurls = true,
     canonical = "https://{{ PackageOwner }}.github.io/{{ PackageName }}.jl",
     assets = ["assets/style.css"],
   ),

template/docs/src/90-developer.md.jinja

@@ -93,3 +93,16 @@ If this is the first time you work with this repository, follow the instructions
    ```
 
 - Then you can open a pull request and work with the reviewer to address any issues.
+
+## Building and viewing the documentation locally
+
+Following the latest suggestions, we recommend using `LiveServer` to build the documentation.
+Here is how you do it:
+
+1. Run `julia --project=docs` to open Julia in the environment of the docs.
+1. If this is the first time building the docs
+   1. Press `]` to enter `pkg` mode
+   1. Run `pkg> dev .` to use the development version of your package
+   1. Press backspace to leave `pkg` mode
+1. Run `julia> using LiveServer`
+1. Run `julia> servedocs()`