Skip to content

Commit

Permalink
feat(plugintestbed): add package
Browse files Browse the repository at this point in the history
  • Loading branch information
GerkinDev committed Mar 2, 2022
1 parent 0afdf9d commit fac9bfb
Show file tree
Hide file tree
Showing 15 changed files with 13,519 additions and 0 deletions.
8 changes: 8 additions & 0 deletions packages/typedoc-plugintestbed/.eslintrc.js
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` ],
},
};
1 change: 1 addition & 0 deletions packages/typedoc-plugintestbed/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
__tests__/mock-fs/**/docs
31 changes: 31 additions & 0 deletions packages/typedoc-plugintestbed/README.md
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.
18 changes: 18 additions & 0 deletions packages/typedoc-plugintestbed/jest.config.js
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/.*' ),
],
};
Loading

0 comments on commit fac9bfb

Please sign in to comment.