cuetorials.com
typedoc
cuetorials.com | typedoc | |
---|---|---|
27 | 29 | |
113 | 7,371 | |
-0.9% | 0.9% | |
4.1 | 9.1 | |
about 1 month ago | 1 day ago | |
CUE | TypeScript | |
BSD 3-clause "New" or "Revised" License | Apache License 2.0 |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
cuetorials.com
-
HCL: Toolkit for Structured Configuration Languages
I have a website I maintain, many people tell me it has helped them
https://cuetorials.com
-
Ask HN: Comment here about whatever you're passionate about at the moment
CUE(lang), because devops & yaml engineering has gotten out of hand
I maintain https://cuetorials.com and am heading up the CUE sig-infra group for the time being
- That's a Lot of YAML
-
Ask HN: Who needs vendors, and vendors, who needs customers?
If you need help with CUE(lang), we maintain https://cuetorials.com and have experience helping others adopt it at their companies
email is in my HN profile, same handle on GitHub and X
- Learn you some CUE for a great good
-
Ask HN: Which Python or Rust-based static site generators to use as of 2023?
If you are more focused on the devops part, and not implementing a static site generator, then go with Python. For our static sites we use Hugo + GH Actions + Kubernetes (since we have a cluster anyway). There is not really any code involved here (example: https://github.com/hofstadter-io/cuetorials.com)
I'm personally interested to try https://docs.dagger.io/sdk/python/ for something. I used the CUE sdk, but it is effectively deprecated at this point. I use a mix of base, make, python, and CUE fro most devops / devex stuff now. Dagger makes it so local & CI stuff runs the same.
- Cue Wins
- Ask HN: Do you have something you continually work on for years?
-
Ask HN: How to find the right tech angel investor for new programming platform?
yup, I'm betting the proverbial ranch on CUE :]
I also maintain https://cuetorials.com
-
hof: The High Code Framework (low-code for devs), a flexible data modeling & code generation system
I also maintain https://cuetorials.com, bet the farm on CUE or something like that :]
typedoc
-
Learn how to document JavaScript/TypeScript code using JSDoc & Typedoc
Firstly, install Typedoc using npm:
- Document Playwright tests with typedoc
-
90% less disk space + 80% faster doc generation w/ TypeDoc. Introducing the "Default Modern Theme" for TypeDoc + complete linkable API docs for the built-in TS lib declarations.
Background:The main bottleneck with the TypeDoc default theme especially for large projects is the verbose HTML for the left-hand navigation that linearly grows for each page based on the project size and consumes a massive amount of disk space; see this TypeDoc issue. The DMT caches the left-hand navigation HTML and dynamically creates a shared web component that is utilized across all pages only making a single copy of the navigation HTML. This reduces disk space utilization by up to 90% and also makes doc generation ~80% faster. I also include some style additions and replace the main search index generation using compressed MesssagePack instead of JSON which reduces the search index size by more than 90%.
-
Prim+RPC: a bridge between JavaScript environments. Easy-to-understand, type-safe, transport-agnostic RPC/IPC for JavaScript, supporting callbacks, batching, file uploads, custom serialization, and more.
While the Prim+RPC server is expected to be JavaScript, I'd like to support other languages through JSON Schema. I wrote a tool that translates TypeDoc comments into RPC-specific documentation. My plan is to turn this result into JSON Schema that can be served with the Prim+RPC server. This means you can get typed suggestions (for instance, from an IDE that understands JSON Schema) when writing requests in JSON files (I wrote a little about this here, still a WIP). From this, you could use your favorite HTTP client in the language of your choice, like but still benefit from having typed requests.
-
What software do you use to write documentation?
Docusaurus has a Typedoc plugin. Also there is a typedoc markdown plugin.
-
Mastering JSDoc: the complete guide for Javascript developers
Finally, JSDoc can be used to generate documentation for your code using tools like JSDoc itself and TypeDoc. These tools generate HTML or Markdown documentation based on your JSDoc annotations, making it easier for others to understand how your code works and how to use it.
-
Opinionated standards for JSDoc
Since you're using TypeScript, use TypeDoc.
-
How to create and publish a TypeScript library with ease
Generates HTML documentation using TypeDoc.
-
I created a game engine using TypeScript. Please roast it.
I was thinking of using something like https://typedoc.org to do it, do you have experience with this sort of tools?
-
Complete rewrite of ESLint (GitHub discussion by the creator)
TSDoc is more consistent, has cleaner documentation, better tooling (e.g. TypeDoc or ESLint plugin) and better support for data structures (e.g. straightforward enums support).
What are some alternatives?
vector - A high-performance observability data pipeline.
tsdoc - A doc comment standard for TypeScript
juicefs - JuiceFS is a distributed POSIX file system built on top of Redis and S3.
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
cue - The home of the CUE language! Validate and define text-based and dynamic configuration
VuePress - 📝 Minimalistic Vue-powered static site generator
cue - CUE has moved to https://github.com/cue-lang/cue
mkdocs-material - Documentation that simply works
hof - Framework that joins data models, schemas, code generation, and a task engine. Language and technology agnostic.
docsify - 🃏 A magical documentation site generator.
Docusaurus - Easy to maintain open source documentation websites.