Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
hexo-typescript-api-box
Advanced tools
Readme
Add this package to your hexo site:
npm install --save hexo-typescript-api-box
Configure this plugin to point it at your docs.json
(see below), in _config.yml
:
typescript_api_box:
data_file: docs.json
NOTE: In some cases generated source filepath
's, that are used when showing source file links in the API box, can be missing path prefix details. This can happen when following a package based project style, like the one used by lerna. To work around this, use the filepath_prefix
config option to add a common path prefix to all generated source filepath
's:
typescript_api_box:
filepath_prefix: packages/apollo-client/src/
Add the code you want to document as a submodule:
git submodule add URL_OF_REPO code
Add typedoc (our branch for now, pending https://github.com/TypeStrong/typedoc/pull/266) as a dependency of your project:
npm install --save typedoc@tmeasday/typedoc#add-source-to-json-built
Generate docs.json with an npm script similar to:
"scripts": {
"build": "cd code; typedoc --json ../docs.json",
"prestart": "npm run build",
"start": "hexo serve",
"predeploy": "npm run build",
"deploy": "hexo-s3-deploy",
}
Note that we've added the
build
script as aprestart
andpredeploy
script which makes sense.
To use a code reference, use the tsapibox
tag:
{% tsapibox ApolloClient.constructor %}
In this version this will be an H3 (nested sidebar entry). We'll probably iterate on this.
Ensure you've added a box for each referenced type, or the links will go nowhere.
The build HTML is styled by the hexo-theme-meteor.
FAQs
An typescript API box for hexo projects
The npm package hexo-typescript-api-box receives a total of 1 weekly downloads. As such, hexo-typescript-api-box popularity was classified as not popular.
We found that hexo-typescript-api-box demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 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
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.