Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add improved docs #63

Merged
merged 7 commits into from
Oct 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
/**
* @typedef {import('./lib/index.js').UrlConfig} UrlConfig
* @typedef {import('./lib/index.js').Options} Options
*/

import remarkValidateLinks from './lib/index.js'

export default remarkValidateLinks
12 changes: 6 additions & 6 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
* @typedef Options
* Configuration.
* @property {string|false} [repository]
* URL to hosted Git.
* If `repository` is nullish, the Git origin remote is detected.
* If the repository resolves to something npm understands as a Git host such
* as GitHub, GitLab, or Bitbucket, full URLs to that host (say,
Expand All @@ -31,14 +32,13 @@
* explicitly.
* @property {string} [root]
* A `root` (`string?`) can also be passed, referencing the local Git root
* directory (the place where `.git` is).
* directory (the folder that contains `.git`).
* If both `root` and `repository` are nullish, the Git root is detected.
* If `root` is not given but `repository` is, [`file.cwd`][cwd] is used.
* If `root` is not given but `repository` is, `file.cwd` is used.
* @property {UrlConfig} [urlConfig]
* If you’re self-hosting a Git server, you can provide URL information
* directly, as `urlConfig` (`Object`).


* If your project is hosted on `github.com`, `gitlab.com`, or `bitbucket.org`,
* this plugin can automatically detect the url configuration.
* Otherwise, use `urlConfig` to specify this manually.
*/

import {check} from './check/index.js'
Expand Down
Loading