Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schoero/unwritten
unwritten automatically generates documentation from your JavaScript or TypeScript library by utilizing JSDoc comments and the TypeScript compiler.
https://github.com/schoero/unwritten
docs documentation documentation-generator javascript jsdoc tsdoc typescript
Last synced: 3 months ago
JSON representation
unwritten automatically generates documentation from your JavaScript or TypeScript library by utilizing JSDoc comments and the TypeScript compiler.
- Host: GitHub
- URL: https://github.com/schoero/unwritten
- Owner: schoero
- License: mit
- Created: 2022-11-26T18:54:16.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T17:13:41.000Z (5 months ago)
- Last Synced: 2024-10-11T12:14:17.607Z (3 months ago)
- Topics: docs, documentation, documentation-generator, javascript, jsdoc, tsdoc, typescript
- Language: TypeScript
- Homepage:
- Size: 3.63 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
---
[](https://github.com/schoero/unwritten/blob/main/LICENSE)
[](https://www.npmjs.com/package/unwritten?activeTab=versions)
[](https://github.com/schoero/unwritten/issues)
[](https://www.npmjs.com/package/unwritten?activeTab=readme)
[](https://github.com/schoero/unwritten/stargazers)
[](https://github.com/schoero/unwritten/actions?query=workflow%3ACI)
---
unwritten is a cli tool to automatically generate documentation from your JavaScript or TypeScript library by utilizing JSDoc comments and the TypeScript compiler to extract types and relevant information.
> [!WARNING]
>
> This project is at a really early stage and currently under heavy development. It is not feature complete and it may not or only partially work with your project. You have been warned.
## Installation
```sh
npm i unwritten
```
## Usage
```sh
unwritten [options]
```
## Options
```sh
--output # Specify the output directory and the
-o # file name. Defaults to ./docs/api
# based on the current working
# directory.
--tsconfig # Provide a tsconfig file used to
-t # compile your project. unwritten will
# try to find the tsconfig by itself if
# no tsconfig.json is provided.
--config # Provide an unwritten config used to
-c # render the documentation. unwritten
# will try to find the .unwritten.json
# config by itself if none is provided
# or uses the default config.
--renderer # Choose the format of the rendered
-r # output. Defaults to `md` for markdown.
# It is also possible to provide a
# custom renderer by providing the path
# to the file that default exports the
# renderer.
--silent # Disables any console output.
-s
--debug # Enables verbose console output.
-d
--version # Returns the installed unwritten
-v # version.
```
## Configuration
You can configure how your documentation will be rendered using a configuration file. The simplest way to create such a configuration file is by using the following command:
```sh
unwritten init
```
This will create a `.unwritten.json` file in the current working directory with the default configuration. You can change or remove any of the options in the configuration file.