https://github.com/evilmartians/astro-typedoc

A tool for building astro-based documentation sites using Typescript types definitions and TSDocs.
https://github.com/evilmartians/astro-typedoc

astro typedoc typescript

Last synced: 3 months ago
JSON representation

A tool for building astro-based documentation sites using Typescript types definitions and TSDocs.

• Host: GitHub
• URL: https://github.com/evilmartians/astro-typedoc
• Owner: evilmartians
• License: mit
• Created: 2023-08-14T09:46:00.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-22T14:55:04.000Z (over 1 year ago)
• Last Synced: 2024-04-16T21:05:27.289Z (10 months ago)
• Topics: astro, typedoc, typescript
• Language: JavaScript
• Homepage:
• Size: 285 KB
• Stars: 7
• Watchers: 25
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# astro-typedoc

Utility for generating Astro pages from `TypeDoc`.

## Testing

There are 3 subfolders is `test/` folder.

1. `types` - this is a stub TypeScript project, contains types, which are used for generating docs

2. `website-types` - a sample site which is generated from `types/` publicly exported types

3. `website-nanostores` - a sample site which is generated from `nanostores` package.

   [`nanostores`](https://github.com/nanostores/nanostores) repository needs to be cloned locally.

   [`@nanostores/router`](https://github.com/nanostores/router) respository needs to be cloned locally.

   Folder structure should look like this:

   ```

   .

   ├── astro-typedoc

   ├── router

   └── nanostores

   ```

### Building sites

`website-types` and `website-nanostores` are Astro sites with enabled integration.

`pnpm run build` to build projects, works for both of them.

`pnpm start` to start a development server for a website