https://github.com/tanepiper/typedoc-plugin-ghpages-cname

A Typedoc Plugin for adding a CNAME file for Github Docs
https://github.com/tanepiper/typedoc-plugin-ghpages-cname

cname github-pages typedoc typedoc-plugin typedocplugin typedocs typescript

Last synced: about 1 year ago
JSON representation

A Typedoc Plugin for adding a CNAME file for Github Docs

• Host: GitHub
• URL: https://github.com/tanepiper/typedoc-plugin-ghpages-cname
• Owner: tanepiper
• License: mit
• Created: 2020-11-20T16:07:37.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-09-23T12:43:58.000Z (over 4 years ago)
• Last Synced: 2025-03-18T15:32:42.847Z (about 1 year ago)
• Topics: cname, github-pages, typedoc, typedoc-plugin, typedocplugin, typedocs, typescript
• Language: TypeScript
• Homepage:
• Size: 16.6 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Typedoc Github Pages CNAME

This [Typedoc](https://typedoc.org) plugin generates a `CNAME` file inside your `docs` directory for Github Pages each time you generate new docs

To use, include the following in your `typedoc.json` config:

```json

{

    "name": "My Docs",

    "out": "docs",

    "cname": "mysite.rocks"

}

```