Skip to content

Commit

Permalink
Restructured repo
Browse files Browse the repository at this point in the history
  • Loading branch information
tgreyuk committed Sep 6, 2024
1 parent 81e6353 commit f413adb
Show file tree
Hide file tree
Showing 250 changed files with 759 additions and 20,505 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.wiki.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Deploy Github Wiki
on:
push:
paths:
- "integrations/github-wiki/docs/**"
- "examples/github-wiki/docs/**"
jobs:
build:
runs-on: ubuntu-latest
Expand All @@ -11,6 +11,6 @@ jobs:
- name: Upload example to Wiki
uses: SwiftDocOrg/github-wiki-publish-action@v1
with:
path: "integrations/github-wiki/docs"
path: "examples/github-wiki/docs"
env:
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,24 @@ This repository contains examples of output generated using [typedoc-plugin-mark
The examples link directly to the typedoc generated output in this repository.
You can also browse the respective directories and view the configuration of each example.

### Core Examples
### Core Output

- [default-example](./examples/core/01-default/docs/README.md) - showcases the default output of the plugin.
- [customized-ux](./examples/core/02-customized-ux/docs/README.md) - showcases how the UX can be customized.
- [single-page-modules](./examples/core/03-single-page-modules/docs/README.md) - showcases output with single page modules.
- [packages](./examples/core/05-packages/docs/README.md) - showcases output for entrypointStrategy "packages".
- [localization](./examples/core/06-localization/docs/README.md) - showcases how output can be output in another language.
- [customization](./examples/core/07-customization/docs/index.md) - showcases how output can be customized with hooks and custom theme.
| Example Link | Description |
| -------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| [Default](./examples/default/docs/README.md) | Highlights how the plugin behaves with default settings. |
| [UX Options](./examples/customized-ux/docs/README.md) | Demonstrates how to adjust the user experience with custom display options. |
| [Single Page Modules](./examples/single-page-modules/docs/README.md) | Shows how documentation can be generated with a single module per page. |
| [Single Page Docs](./examples/single-page-docs/docs/README.md) | Shows how docs can be generated to a single file with a single entry point. |
| [Packages](./examples/packages/docs/README.md) | Illustrates the output for the "packages" entrypoint strategy. |
| [Localization](./examples/localization/docs/README.md) | Shows how to localize the plugin output to different languages. |
| [Customization](./examples/customization/docs/index.md) | Demonstrates advanced customization using hooks and custom themes. |

### Utils Examples
### Utils

- [frontmatter](./examples/utils/frontmatter/docs/README.md) - showcases how frontmatter can be added to pages.
- [remark](./examples/utils/remark/docs/README.md) - showcases how output can be parsed with Remark plugins.
| Example Link | Description |
| ---------------------------------------------------------- | ------------------------------------------------------- |
| [Frontmatter](./examples/utils/frontmatter/docs/README.md) | Showcases how frontmatter can be added to pages. |
| [Remark](./examples/utils/remark/docs/README.md) | Showcases how output can be parsed with Remark plugins. |

## Running Examples Locally

Expand All @@ -30,6 +35,7 @@ If you would like to explore the examples and configure yourself clone the repos
```shell
git clone [email protected]:typedoc2md/typedoc-plugin-markdown-examples.git
cd typedoc-plugin-markdown-examples
git submodule update --init --recursive
```

### 2. Install Dependencies
Expand All @@ -49,5 +55,5 @@ npm run docs
To run a specific example:

```shell
npm run docs --workspace ux-options
npm run docs --workspace display-options
```
191 changes: 0 additions & 191 deletions dummy-api/src/billing.ts

This file was deleted.

Loading

0 comments on commit f413adb

Please sign in to comment.