datastation-documentation
typedoc
datastation-documentation | typedoc | |
---|---|---|
3 | 29 | |
3 | 7,371 | |
- | 0.9% | |
0.0 | 9.1 | |
almost 2 years ago | 2 days ago | |
HTML | TypeScript | |
GNU General Public License v3.0 or later | 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.
datastation-documentation
-
Show HN: DataStation – App to easily query, script, and visualize data
Hey folks! I quit my job at Oracle almost a year ago now to build DataStation. It's an app I've wanted as an engineering manager for years now.
DataStation helps you query a variety of data sources (conventional SQL like PostgreSQL and MySQL, non-SQL like Prometheus or Elasticsearch), files and HTTP APIs. It is not a SQL layer on top of these various APIs like FDW in Postgres or Apache Calcite. For Prometheus you query with PromQL. For Elasticsearch you query with Lucene. And for SQL databases you query with their SQL dialect.
DataStation is made of panels (other apps might call them cells) that each produce a result. Panels can refer to other panels. These allow you to build workflows that cross the boundary of a particular datasource. For example you might have some data in a CSV a product manager gave you and the bulk of your data is in PostgreSQL. DataStation helps you pull together these data sets and script them.
DataStation is mainly a desktop app today where the end result is that you export graph SVGS or HTML tables or markdown tables or just a CSV file. All this data stays on your laptop so it's as easy to use in a corporate environment as any existing SQL IDE or Jupyter Notebook.
In the last year it's reached 1.5k stars on Github, over 1000 unique users and currently on-average about 40 fairly active users per month (defined as having opened the app more than a few times).
DataStation is primarily an Electron app but the code that evaluates panels is written in Go.
You can find a ton of tutorials on how to interact with supported databases on the DataStation website: https://datastation.multiprocess.io/docs/.
Looking forward to your feedback!
-
Ask HN: Tools to visualize data in SQL database?
There are primarily a bunch of tutorials for getting started [0] (these are up to date) and some old videos (not up to date) [1].
[0] https://datastation.multiprocess.io/docs/
[1] https://www.youtube.com/channel/UCGOQFKonPUVo5LgxQDW26yg/vid...
-
Ask HN: What are you using for public documentation these days?
A markdown generator embeds markdown from a Github repo into the marketing site. This way the marketing site is kept private while anyone can easily contribute to docs.
Docs are kept in separate folders for each release.
https://github.com/multiprocessio/datastation-documentation
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?
Redash - Make Your Company Data Driven. Connect to any data source, easily visualize, dashboard and share your data.
tsdoc - A doc comment standard for TypeScript
franchise - 🍟 a notebook sql client. what you get when have a lot of sequels.
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
Motor Admin - Deploy a no-code admin panel for your application in less than a minute. Stop wasting time on custom internal tools and focus on the actual product. Motor Admin allows to launch a custom admin panel for any application.
VuePress - 📝 Minimalistic Vue-powered static site generator
superset - Apache Superset is a Data Visualization and Data Exploration Platform
mkdocs-material - Documentation that simply works
manconvert - Convert troff-style man pages to doxygen source or formatted HTML
docsify - 🃏 A magical documentation site generator.
awesome-business-intelligence - Actively curated list of awesome BI tools. PRs welcome!
Docusaurus - Easy to maintain open source documentation websites.