https://github.com/jsdocs-io/web

jsDocs.io is an open source documentation host for Javascript and Typescript packages.
https://github.com/jsdocs-io/web

docs documentation-website javascript nextjs npm tailwindcss typescript

Last synced: 3 months ago
JSON representation

jsDocs.io is an open source documentation host for Javascript and Typescript packages.

• Host: GitHub
• URL: https://github.com/jsdocs-io/web
• Owner: jsdocs-io
• License: agpl-3.0
• Created: 2020-08-19T19:26:06.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-02T21:35:03.000Z (3 months ago)
• Last Synced: 2024-08-02T23:56:28.569Z (3 months ago)
• Topics: docs, documentation-website, javascript, nextjs, npm, tailwindcss, typescript
• Language: TypeScript
• Homepage: https://www.jsdocs.io
• Size: 3.66 MB
• Stars: 108
• Watchers: 2
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


    

        

    



# [jsDocs.io](https://www.jsdocs.io)

[![Build status](https://img.shields.io/github/actions/workflow/status/jsdocs-io/web/main.yml?branch=main)](https://github.com/jsdocs-io/web/actions?query=workflow%3ACI)

[![Coverage](https://img.shields.io/codecov/c/gh/jsdocs-io/web)](https://codecov.io/gh/jsdocs-io/web)

![Language](https://img.shields.io/github/languages/top/jsdocs-io/web)

[![License](https://img.shields.io/github/license/jsdocs-io/web)](https://github.com/jsdocs-io/web/blob/main/LICENSE)

jsDocs.io is an open source documentation host inspired by [GoDoc](https://pkg.go.dev/) and [Docs.rs](https://docs.rs/) that automatically extracts and renders the public API and documentation of Typescript and typed Javascript packages published on [npm](https://www.npmjs.com/).

To learn more about jsDocs.io, please visit our [About page](https://www.jsdocs.io/about).



    

        

    



## Package Authors

If you are a developer interested in improving your packages' public documentation, please visit our [package documentation guide](https://www.jsdocs.io/guide).

## Sponsor

You can support this project by [**becoming a backer or sponsor on Patreon**](https://www.patreon.com/jsdocs_io) with a monthly contribution and have your name or company logo listed on the [Sponsor page](https://www.jsdocs.io/sponsor) on jsDocs.io.

## Feedback

To report bugs, leave suggestions, or ask questions, please [open an issue](https://github.com/jsdocs-io/web/issues).

You can also reach us on Twitter at [@jsDocs](https://twitter.com/jsDocs) or by email at [email protected].

## License

    AGPL-3.0-or-later

Copyright (C) 2021 Edoardo Scibona

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU Affero General Public License as published by

the Free Software Foundation, either version 3 of the License, or

(at your option) any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License

along with this program. If not, see .