typedoc
semver
typedoc | semver | |
---|---|---|
30 | 727 | |
7,398 | 7,052 | |
1.3% | 1.0% | |
9.1 | 0.6 | |
6 days ago | 28 days ago | |
TypeScript | ||
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.
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).
semver
-
The right development flow: Better than Agile
We increase the version of our product as specified in SemVer and deploy it to production, preferably following good deployment practices to have no downtime.
-
Git commit helper: add emojis to your commits
Using Conventional Commits β as a standard for your commit messages, makes Semantic Versioning π as easy as can be, with tools like Conventional Changelog π Standard Version π and Semantic Release π¦π
-
Why write a library?
Semantic Versioning: for every update (major, minor, or patch) made, increment the version number according to semantic versioning.
-
Node package managers (npm, yarn, pnpm) - All you need to know
npm automates the process of installing, updating, and managing dependencies, which helps to avoid "dependency hell." It supports semantic versioning (semver) that automatically handles patch and minor updates without breaking the existing code, thus maintaining stability across projects. npm also provides the capability to run scripts and commands defined in package.json, which can automate common tasks such as testing, building, and deployment.
-
Snyk CLI: Introducing Semantic Versioning and release channels
We are pleased to introduce Semantic Versioning and release channels to Snyk CLI from v.1.1291.0 onwards. In this blog post, we will share why we are introducing these changes, what problems these changes solve for our customers, and how our customers can opt-in according to their needs.
-
Master the Art of Writing and Launching Your Own Modern JavaScript and Typescript Library in 2024
Following the Semantic Versioning rules, you should raise the version number every time you need to publish your library. In your "package.json" file, you need to change the version number to reflect whether the changes are major, minor, or patch updates.
-
Using semantic-release to automate releases and changelogs
Semantic Versioning: An established convention for version numbers following the pattern MAJOR.MINOR.PATCH
-
Essential Command Line Tools for Developers
Increases the major of the latest tag and prints it As per the Semver spec, it'll also clear the pre-releaseβ¦
-
Testing Our Tasks
The reason for this is that software libraries and package managers, in general, but specifically here, rely on semantic versioning. Semantic versioning is really useful for distributing packages in a predictable way. What does this look like for our project?
-
What is Semantic Versioning and why you should use it for your software ?
For a more detailed and comprehensive guide on semantic versioning, visit https://semver.org
What are some alternatives?
tsdoc - A doc comment standard for TypeScript
react-native - A framework for building native applications using React
nextra - Simple, powerful and flexible site generation framework with everything you love from Next.js.
semantic-release - :package::rocket: Fully automated version management and package publishing
VuePress - π Minimalistic Vue-powered static site generator
standard-version - :trophy: Automate versioning and CHANGELOG generation, with semver.org and conventionalcommits.org
mkdocs-material - Documentation that simply works
changesets - π¦ A way to manage your versioning and changelogs with a focus on monorepos
docsify - π A magical documentation site generator.
helmfile - Deploy Kubernetes Helm Charts
Docusaurus - Easy to maintain open source documentation websites.
Poetry - Python packaging and dependency management made easy