-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
13,519 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
module.exports = { | ||
root: true, | ||
extends: [ '@knodes/eslint-config/ts' ], | ||
env: { node: true }, | ||
parserOptions: { | ||
project: [ `${__dirname}/tsconfig.build.json`, `${__dirname}/tsconfig.spec.json` ], | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
__tests__/mock-fs/**/docs |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# typedoc-plugin-pages | ||
|
||
> A TypeDoc plugin that lets you integrate your own pages into the documentation output | ||
[![npm](https://img.shields.io/npm/v/typedoc-plugin-pages?color=brightgreen)](https://www.npmjs.com/package/typedoc-plugin-pages) | ||
|
||
This plugin is based on [typedoc-plugin-loopingz-pages](https://github.com/loopingz/typedoc-plugin-loopingz-pages), which is in turn a fork of [typedoc-plugin-pages](https://github.com/mipatterson/typedoc-plugin-pages). Integrating it in this monorepo should (I hope) make easier maintainance. | ||
|
||
## Compatibility | ||
|
||
This plugin version should match TypeDoc `major.minor.x` for compatibility. | ||
|
||
## Features | ||
|
||
- 🔍 Search integration | ||
- 🔗 Interpage hyperlinks | ||
- 🎨 Integrated Theme | ||
- 📑 Reflection Navigation Title Customization | ||
- ✏️ Integrated spell-checking (coming soon...) | ||
|
||
## Demo | ||
|
||
You can view a live demo of the original `typedoc-plugin-pages` [here](https://mipatterson.github.io/typedoc-plugin-pages/). | ||
|
||
## Usage | ||
|
||
See the [Quick Start](https://mipatterson.github.io/typedoc-plugin-pages/pages/Getting%20Started/quick-start.html) guide to get started. | ||
|
||
## Supported Versions of TypeDoc | ||
|
||
This plugin is designed to work with as many versions of TypeDoc as possible. It has been tested with the following versions `0.16.5` through `0.17.6`. If you are reporting an issue, please include the version of TypeDoc you are using the plugin with. |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
const { resolve } = require( 'path' ); | ||
|
||
const base = require( '../../jest.config.base' ); | ||
/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */ | ||
module.exports = { | ||
...base, | ||
projects: [ | ||
base.projects[0], | ||
{ | ||
...base.projects[1], | ||
setupFilesAfterEnv: [ ...base.projects[1].setupFilesAfterEnv, '@testing-library/jest-dom' ], | ||
}, | ||
], | ||
watchPathIgnorePatterns: [ | ||
...( base.watchPathIgnorePatterns ?? [] ), | ||
resolve( __dirname, '__tests__/integration/mock-fs/.*' ), | ||
], | ||
}; |
Oops, something went wrong.