Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
@neo4j-devtools/workspace-guides
Advanced tools
To preview AsciiDoc guides:
npx @neo4j-devtools/workspace-guides -w
Open the Example tab in Workspace Preview,
Scroll to Playlist Preview
-> Manifest origin override
, fill the text field
with the server's URL (the default is http://localhost:4000/).
Click Update URL
and the guides available for preview will be listed in the
Guides
section.
If you add/rename guides you might need to click the Refetch manifest
button
for them to appear.
USAGE
$ parse-guides [-i INPUT_DIR_PATH] [-o OUTPUT_DIR_PATH] [--root-url ROOT_URL] [-w] [-m PATH_TO_MANIFEST]
FLAGS
-i, --input-dir=<value> [default: .] Path to directory containing .adoc guides
-o, --output-dir=<value> [default: generated tmp directory] Path to directory that will contain .json guides
--root-url=<value> Base URL that output files will be served from
-w, --watch Watch the input directory for changes and automatically
rebuild guides, also hosts the guides.
-m, --manifest=<value> Path to guides manifest
--dry-run
DESCRIPTION
Parse Workspace guides from Adoc to JSON.
EXAMPLES
$ parse-guides --watch
$ parse-guides -i path/to/guides/dir -o output/path --watch
$ parse-guides -m path/to/manifest.json
$ parse-guides -m path/to/manifest.json -o output/path
NOTES
The script searches for guides recursively in the input directory, and the path
is be preserved in the output directory.
When specifying a manifest file the `--input-dir` flag is ignored.
The guides manifest must be a JSON file containing a mapping of IDs and the
corresponding url
for the adoc guide and an optional base URL for the images
contained in the guide. The typing for the manifest is the following.
type GuideManifest = Record<string, { url: string; imgBaseUrl?: string }>;
Example manifest:
{
"movies": {
"url": "https://raw.githubusercontent.com/neo4j-graph-examples/movies/main/documentation/movies.workspace.adoc",
"imgBaseUrl": "https://raw.githubusercontent.com/neo4j-graph-examples/movies/main/documentation/img/"
},
"recommendations": {
"url": "https://raw.githubusercontent.com/neo4j-graph-examples/recommendations/main/documentation/recommendations.workspace.adoc",
"imgBaseUrl": "https://raw.githubusercontent.com/neo4j-graph-examples/recommendations/main/documentation/img/"
}
}
Image assets used in guides are copied to output directory, to avoid conflicts, they are placed in folders named after guide ID of the guide that uses them. To use correct absolute URLs --root-url
CLI argument must be specified.
Prerequisites:
a guide file named <input-dir>/guide.workspace.adoc
with following contents:
== Guide Title
image::asset.svg[]
a GitHub repository neo4j/guides
used to host JSON output on GitHub Pages.
GitHub Pages URLs format is https://<owner>.github.io/<repository>
hence root URL will be https://neo4j.github.io/guides
:
parse-guides -i <input-dir> -o <output-dir> --root-url https://neo4j.github.io/guides
Result:
<output-dir>/guide.json
;<output-dir>/guide/asset.svg
;https://neo4j.github.io/guides/guide/asset.svg
.FAQs
## Previewing guides
The npm package @neo4j-devtools/workspace-guides receives a total of 20 weekly downloads. As such, @neo4j-devtools/workspace-guides popularity was classified as not popular.
We found that @neo4j-devtools/workspace-guides demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.