
Product
Introducing Webhook Events for Pull Request Scans
Add real-time Socket webhook events to your workflows to automatically receive pull request scan results and security alerts in real time.
@wixc3/docs
Advanced tools
Tool + CLI for docs generation from TSDocs
Site pages includes the following templates from docs-config:
index.md - main page header
package.md - packages root page header
item.md - header for other files
There are many awesome macros you can use in your TDDocs. Using macros look like this [[[macro and args]]]
Variable | Description |
---|---|
github | A link to the package on github Usage: inside a ts-docs comment block:
|
githubBuildStatus | A github build status badge Usage: inside a ts-docs comment block:
|
githubPages | A link to the project's github pages Usage: inside a ts-docs comment block:
where uri can be an inner page if caption is provided a markdown link will be created, otherwise the raw root URL will replace the macro |
gitRepo | Project's current package name, in a url friendly format Usage: inside a ts-docs comment block:
where field can be: host | org | repo | pages | github |
h | Heading - since ts-docs to not natively allow for markdown formatting, this macro is used to create a #, ##, ## etc Usage: inside a ts-docs comment block:
|
include | Include another markdown file (that may also have macros) Usage: inside a ts-docs comment block:
|
listMacros | Lists all the available macros Usage: inside a ts-docs comment block:
|
npmBadge | A npm version badge Usage: inside a ts-docs comment block:
|
packageName | Project's current package name Usage: inside a ts-docs comment block of a package:
Will be replace by the full package name, i.e |
packageNameUrl | Project's current package name, in a url friendly format Usage: inside a ts-docs comment block of a package:
This is useful for generating links and badges |
rootPackageName | Project's root package name Usage: inside a ts-docs comment block:
|
unscopedPackageName | Project's current package name, unscoped Usage: inside a ts-docs comment block of a package: *docs Will be replace by the full package name, i.e |
yarn add @wixc3/docs
yarn docs init
git push
yarn docs build
yarn docs readme
Function | Description |
---|---|
buildDocs(config, steps, macros) | Build docs markdown |
cli() | |
createReadme(config, siteUrl) | |
init(config, force) | Initialize docs pre-requisites: - Adds api-extractor.json to packages - Adds git pages action - Creates configs and templates in docs-config |
Type Alias | Description |
---|---|
BuildSteps | |
Macros | |
UserConfig |
FAQs
API
We found that @wixc3/docs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 68 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Add real-time Socket webhook events to your workflows to automatically receive pull request scan results and security alerts in real time.
Research
The Socket Threat Research Team uncovered malicious NuGet packages typosquatting the popular Nethereum project to steal wallet keys.
Product
A single platform for static analysis, secrets detection, container scanning, and CVE checks—built on trusted open source tools, ready to run out of the box.