Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mintlify/writer
✍️ AI powered documentation writer
https://github.com/mintlify/writer
intellij-plugin machine-learning productivity vscode-extension
Last synced: 3 days ago
JSON representation
✍️ AI powered documentation writer
- Host: GitHub
- URL: https://github.com/mintlify/writer
- Owner: mintlify
- License: mit
- Created: 2021-12-22T23:07:58.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-04T20:04:45.000Z (5 months ago)
- Last Synced: 2024-12-09T01:36:27.886Z (5 days ago)
- Topics: intellij-plugin, machine-learning, productivity, vscode-extension
- Language: TypeScript
- Homepage: https://www.mintlify.com/writer
- Size: 9.51 MB
- Stars: 2,832
- Watchers: 11
- Forks: 130
- Open Issues: 66
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-star - writer
README
## Notice: Mintify Writer is no longer being updated by the Mintlify Team. Get started with our customer documentation product [here](mintlify.com/start).
# ✍️ Mintlify Writer
![Ratings](https://img.shields.io/visual-studio-marketplace/r/mintlify.document) [![discord](https://img.shields.io/discord/911693009253466123?logo=Discord&logoColor=white)](https://discord.gg/6W7GuYuxra) [![GitHub Stars](https://img.shields.io/github/stars/mintlify/vscode-docs?style=social)](https://github.com/mintlify/vscode-docs) [![Twitter](https://img.shields.io/twitter/follow/mintlify?style=social)](https://twitter.com/mintlify)
Writing documentation sucks. Let Mintlify take care of it. Just highlight code and see the magic.
[![Demo](vscode/assets/demo-docs.gif)](https://www.loom.com/embed/3dbfcd7e0e1b47519d957746e05bf0f4)
### 👩💻 How to generate documentation
**Step 1** Highlight code or place cursor on the line you want to document
**Step 2** Click on the `Write Docs` button (or hit ⌘ + .)### 📝 Languages supported
- Python
- JavaScript
- TypeScript
- JSX and TSX files
- C and C++
- PHP
- Java
- C#
- Ruby
- Rust
- Dart
- Go
- 🚧 More under construction### 📑 Docstring formats supported
- JSDoc
- reST
- NumPy
- DocBlock
- Doxygen
- Javadoc
- GoDoc
- XML
- 🚧 More under construction### 🚨 Disclaimer
We never store your code, but your code does leave your machine.
---
### More information
[Website](https://mintlify.com/)
[Twitter](https://twitter.com/mintlify)_Built with 💚 by the Mintlify team_