https://github.com/complexlity/jsdoc-tutorial
https://github.com/complexlity/jsdoc-tutorial
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/complexlity/jsdoc-tutorial
- Owner: Complexlity
- Created: 2023-10-08T15:59:00.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-08T18:46:29.000Z (over 2 years ago)
- Last Synced: 2025-03-21T04:44:11.328Z (about 1 year ago)
- Language: JavaScript
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JSDoc: The Sound Alternative to Typescript
This repository contains the source code to this [article on JSDoc](https://example.com)
## Getting Started
The source file is found in [src/jsdoc.js](src/jsdoc.js)
## How to edit and run
- Create a new `.js` file containing jsdoc syntax in the [src folder](src) or modify the [existing file](src/jsdoc.js)
- Compile the code
```bash
npm run compile
```
- Open [out/index.html](out/index.html) in the browser
- Find the types declaration file in [out/types.d.ts](out/types.d.ts) and copy if you need.