https://github.com/donmccurdy/greendoc

🌿 An adaptable system for generating documentation of TypeScript and JavaScript APIs.
https://github.com/donmccurdy/greendoc

Last synced: 2 days ago
JSON representation

🌿 An adaptable system for generating documentation of TypeScript and JavaScript APIs.

• Host: GitHub
• URL: https://github.com/donmccurdy/greendoc
• Owner: donmccurdy
• License: other
• Created: 2022-11-20T22:44:49.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-18T02:19:16.000Z (16 days ago)
• Last Synced: 2024-09-18T05:57:20.441Z (15 days ago)
• Language: TypeScript
• Homepage:
• Size: 2.91 MB
• Stars: 11
• Watchers: 2
• Forks: 1
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 🌿 greendoc

[![Latest NPM release](https://img.shields.io/npm/v/@greendoc/parse.svg)](https://www.npmjs.com/package/@greendoc/parse)

[![License](https://img.shields.io/badge/license-BlueOak--1.0.0-007ec6.svg)](https://github.com/donmccurdy/greendoc/blob/main/LICENSE.md)

[![Build Status](https://github.com/donmccurdy/greendoc/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/donmccurdy/greendoc/actions?query=workflow%3ACI)

_An adaptable system for generating documentation of TypeScript APIs._

> ⚠️ **NOTICE:** WORK IN PROGRESS / NOT READY FOR USE

## Packages

- [`@greendoc/docs`](./packages/docs): _Documentation for, and example of, the greendoc system._

- [`@greendoc/parse`](./packages/parse): _Parses TypeScript and builds a strongly-typed API model in JSON._

- `@greendoc/html`: _Renders the API model in HTML._

- [`@greendoc/svelte`](./packages/svelte): _Renders the API model in HTML, using [Svelte](https://svelte.dev/)._

- `@greendoc/react`: _Renders the API model in HTML, using [React](https://reactjs.org/)._

- `@greendoc/i18n`: _Provides [internationalization (i18n)](https://web.dev/learn/design/internationalization/) support._

## License

Licensed under [Blue Oak Model License 1.0.0](/LICENSE.md).