Skip to content

Commit f413adb

Browse files
committed
Restructured repo
1 parent 81e6353 commit f413adb

File tree

250 files changed

+759
-20505
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

250 files changed

+759
-20505
lines changed

.github/workflows/ci.wiki.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Deploy Github Wiki
22
on:
33
push:
44
paths:
5-
- "integrations/github-wiki/docs/**"
5+
- "examples/github-wiki/docs/**"
66
jobs:
77
build:
88
runs-on: ubuntu-latest
@@ -11,6 +11,6 @@ jobs:
1111
- name: Upload example to Wiki
1212
uses: SwiftDocOrg/github-wiki-publish-action@v1
1313
with:
14-
path: "integrations/github-wiki/docs"
14+
path: "examples/github-wiki/docs"
1515
env:
1616
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,24 @@ This repository contains examples of output generated using [typedoc-plugin-mark
77
The examples link directly to the typedoc generated output in this repository.
88
You can also browse the respective directories and view the configuration of each example.
99

10-
### Core Examples
10+
### Core Output
1111

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

19-
### Utils Examples
22+
### Utils
2023

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

2429
## Running Examples Locally
2530

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

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

5157
```shell
52-
npm run docs --workspace ux-options
58+
npm run docs --workspace display-options
5359
```

dummy-api/src/billing.ts

Lines changed: 0 additions & 191 deletions
This file was deleted.

0 commit comments

Comments
 (0)