Skip to content

doc-detective/doc-detective.github.io

Repository files navigation

Doc Detective documentation

Get started

  1. Install the dependencies:

    • VSCode Dev Container:

      1. Install Docker.
      2. In VSCode, open the Command Palette and run "Dev Containers: Rebuild and Reopen in Container".
    • Manual install:

  2. Start the local server:

    npm run start
  3. Make your changes.

    • For navigation and theme-based changes, see Just the Docs.
    • For infrastructure and template processing changes, see Jekyll.
    • For diagramming syntax, see Mermaid.
  4. Commit your changes. When your changes merge into the main branch, GitHub Pages automatically republishes the documentation.