https://github.com/jcalixte/doc-jit

Documentation just in time
https://github.com/jcalixte/doc-jit

Last synced: about 2 months ago
JSON representation

Documentation just in time

• Host: GitHub
• URL: https://github.com/jcalixte/doc-jit
• Owner: jcalixte
• License: mit
• Created: 2023-03-25T08:26:56.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-12T16:36:59.000Z (7 months ago)
• Last Synced: 2024-09-17T03:35:21.974Z (4 months ago)
• Language: TypeScript
• Size: 3.41 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Doc-JIT

 *Just In Time* documentation.

## Introduction

Display the right documentation when you need it. `Doc-JIT` is a VS Code extension for developers to open the most relevant documentation when coding features.

## Getting started

There are 2 ways to use just in time documentation:

### The configuration file

*This is the recommended way if you already have a documentation.*

`Doc-JIT` uses [cosmiconfig](https://github.com/davidtheclark/cosmiconfig) for configuration file support. You can either configure with:

1. A `"doc-jit"` key in your package.json file.

1. A `.doc-jitrc` file written in JSON or YAML.

1. A `.doc-jitrc.json`, `.doc-jitrc.yml`, `.doc-jitrc.yaml`, or `.doc-jitrc.json5` file.

1. A `.doc-jitrc.js`, `.doc-jitrc.cjs`, doc-jit.config.js, or doc-jit.config.cjs file that exports an object using module.exports.

1. A `.doc-jitrc.toml` file.

The configuration file will be resolved starting from the location of the file being formatted, and searching up the file tree until a config file is (or isn’t) found.

Example:

```json

{

  "patterns": {

    "**/modules/**/api/**/*.hook.ts": "https://link-to-fetching-api-documentation.io",

    "**/shared/utils/**": [

      "https://link-to-shared-module-documentation.io",

      "https://link-to-util-documentation.io"

    ]

  }

}

```

ℹ️ You can link to the same documentation for different patterns and you can label the resources:

```json

{

  "patterns": {

    "**.test.ts, **.spec.ts": {

      "label": "Vitest documentation",

      "uri": "https://vitest.dev/"

    }

  }

}

```

[Testing doc jit for test files](https://github.com/jcalixte/doc-jit/assets/3417063/35dea33a-97fe-4d22-b6ab-e1a16e309a83)

### The documentation `.doc-jit` directory

If you want to have the documentation close to the code, you can in a `doc-jit` directory and following these steps:

1. Create a `.doc-jit` directory next to `src`,

2. write your documentation based on your architecture,

3. use wildcards `__` when folders have specific names (eg: `modules/__/components/component.md` works for `modules/user/component/` or `modules/book/component/`)

![Demo](./assets/just-in-time-50.gif)

___

## References

[Icon created by Hilmy Abiyyu A. - Flaticon](https://www.flaticon.com/free-icons/exam)