detect_get_started

docblock 
detect_get_started(module_name::Module; dir::String="docs/articles") -> Union{String, Nothing}

Find a “Get Started” article by looking for files matching common naming patterns.

Searches for (in order):

  1. {module_name}.qmd (package name)
  2. get-started.qmd
  3. getting-started.qmd
  4. quickstart.qmd
  5. introduction.qmd
  6. intro.qmd

Arguments

  • module_name::Module: The module being documented
  • dir::String: Directory containing articles

Returns

Path to the “Get Started” article, or nothing if not found.

Example

get_started = detect_get_started(MyPackage)
# "articles/mypackage.qmd" or nothing