Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@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
The npm package @wixc3/docs receives a total of 0 weekly downloads. As such, @wixc3/docs popularity was classified as not popular.
We found that @wixc3/docs demonstrated a healthy version release cadence and project activity because the last version was released less than 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.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.