effect-ts / docgen Goto Github PK
View Code? Open in Web Editor NEWAn opinionated documentation generator for Effect projects
Home Page: https://effect-ts.github.io/docgen
License: MIT License
An opinionated documentation generator for Effect projects
Home Page: https://effect-ts.github.io/docgen
License: MIT License
2.4.11
Add some invalid typescript or an invalid assert to an example, run docgen.
Docgen should report the TSC and TSX errors?
Docgen reports no errors
Here is a repro, also tried updating all dependencies but still no change.
When I add debug logs to the output of the TSC command, I can see the errors and non-zero exit code, but docgen succeeds anyways:
For example, see the following hexdocs for the Phoenix web framework in Elixir.
https://hexdocs.pm/phoenix/Phoenix.html (The chainlink icon on the left (shows up on hover) links to the doc just like docgen
, the tag icon on the right to the source code).
Not sure if docgen should present this in the exact same way, but having this functionality would be nice!
I don't know if I'm missing something, but running pnpm run docgen
on windows is logging [INFO] 0 module(s) found
and no docs are generated. Ran on effect
and schema
projects.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.