A package for generating documentation for TypeScript / JavaScript projects.

This is a GitHub Action to build your TypeScript documentation with TypeDoc. This action can easily be combined with other deployment actions, in order to publish the generated documentation to, for example, GitHub Pages. TypeDoc templates are also supported.

This action is inspired by andstor/jsdoc-action by André Storhaug.

The following example workflow step will generate documentation for all source files in the ./src directory and output the built files to the ./out directory.

- name: Build
  uses: erikyo/tsdoc-action@v1
  with:
    source_dir: ./src/*
    output_dir: ./docs
    front_page: README.md

The tsdoc-action is a JavaScript action and is supported on both Linux, MacOS, and Windows. The action supports stable versions of Node.js 16 and later.

The following input variables options can/must be configured:

Certainly! Here's an updated version of your README table with some corrections and additions:

Please note that I added the missing options and adjusted the names of some options to match the actual code implementation. Feel free to adapt it further based on your preferences.

You can use TypeDoc templates with this action.
Just set the theme or the plugin input variable to the name of the template you want to use and use the install_module to install that package (this needs to be the template's package name.).

To use a TypeDoc configuration file located in your repository, you will need to specify the path to the file in the config_file input variable. Normally, if you use the actions/checkout, this will just resolve to tsconfig.json or typedoc.json.

An example for deploying TypeDoc generated documentation to GitHub Pages with actions-gh-pages.

This tsdoc-action workflow configuration uses the default TypeDoc template and uses the root README.md file as the front page.

# Simple workflow for deploying static content to GitHub Pages
name: TSDoc Actions

on:
  release:
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  # Single deploy job since we're just deploying
  deploy:
    name: Deploy Documentation

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    # Specify runner + deployment step
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: 16
          cache: "npm"

      - name: TSDoc Action
        uses: erikyo/tsdoc-action@v1
        with:
          source_dir: ./src/*
          output_dir: ./docs
          front_page: README.md

      - name: Setup Pages
        uses: actions/configure-pages@v3

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          # Upload entire repository
          path: './docs'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

Copyright © 2023 Erik Golinelli

The tsdoc-action GitHub action is licensed under the Apache License, Version 2.0.
See the LICENSE file for more information.