Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
dgeni-packages
Advanced tools
A collection of dgeni packages for generating documentation from source code
This repository contains a collection of dgeni packages that can be used by the dgeni documentation generator to create documentation from source code.
Out of the box there are the following packages:
jsdoc
- a standard set of processors that can extract jsdoc documents and render them as HTML.ngdoc
- (depends upon the jsdoc
package) an extra set of processors and templates that
are specific to angularjs projects.jsdoc
PackageThis package contains the following processors:
doc-extractor
- used to load up documents from files. This processor can be configured to use a
set of extractors. The jsdoc
package has a single js
extractor, which can extract documents
from jsdoc style comments in files.tag-parser
- parses the jsdoc tags in the extracted documents.tag-extractor
- extracts the tags information and converts it to specific properties on
the documents, based on a set of tag-definitions. The jsdoc
package contains definitions for the
following tags: name
, memberof
, param
, property
, returns
, module
, description
, usage
,
animations
, constructor
, class
, classdesc
, global
, namespace
and kind
.nunjucks-renderer
- uses the Nunjucks template library to render the documents into files, such
as HTML or JS, based on templates.This package does not provide any templates.
ngdoc
PackageThere is one new document extractor in this package, ngdoc
, which can pull a single document from
an ngdoc content file.
On top of the processors provided by the jsdoc
package, this packages adds the following processors:
filter-ngdocs
-
For AngularJS we are only interested in documents that contain the @ngdoc tag. This processor
removes docs that do not contain this tag.
memberof
-
All docs that have a @memberof
tag are attached to their parent document and removed from the top
level list of docs.
links
-
Parse all {@link ... }
inline tags in the docs and replace with real anchors. This processor is
able to compute URLs for code references.
examples
-
Parse the <example>
tags from the content, generating new docs that will be converted to extra
files that can be loaded by the application and used, for example, in live in-place demos of the
examples and e2e testing.
module
-
Some docs that represent a module. The processor will compute the package name for the module (e.g.
angular or angular-sanitize). It also collects up all documents that belong to the module and
attaches them to the module doc in the components
property.
paths
-
This processor computes the URL to the document and the path to the final output file for the
document.
service-provider-mapping
- relates documents about angular services to their corresponding
angular service provider document.
This package also provides a set of templates for generating an HTML file for each document: api, directive, error, filter function, input, module, object, overview, provider, service, type and a number to support rendering of the runnable examples.
We render each of these documents as an HTML page. We use the "nunjucks" JavaScript template tool-kit to generate HTML based on the data in each document. We have nunjucks tags and filters that can render links and text as markdown and will highlight code.
The template used to render the doc is computed by a templateFinder
, which uses the first match
from a set of patterns in a set of folders, provided in the configuration. This allows a lot of control to provide
generic templates for most situations and specific templates for exceptional cases.
Here is an example of the angularjs patterns:
rendering: {
...
templatePatterns: [
'${ doc.template }',
'${ doc.id }.${ doc.docType }.template.html',
'${ doc.id }.template.html',
'${ doc.docType }.template.html'
],
...
templateFolders: [
'templates'
]
},
v0.5.0 03/07/2014
New Features
Bug Fixes
FAQs
A collection of dgeni packages for generating documentation from source code
The npm package dgeni-packages receives a total of 4,107 weekly downloads. As such, dgeni-packages popularity was classified as popular.
We found that dgeni-packages demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 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
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.