#140 (all)
JavaScript (change)
17 seconds
about 1 year ago

This page shows an evaluation of the project's documentation.

Each class, module, method, etc. is given a grade based on how complete the docs are.

The bar above shows the distribution of these grades.

JavaScript support is still young. Please report any mistakes Inch makes!
Seems really good
A
compilerPrototype.visitUnorderedItems in /lib/stringify.js E
A
compilerPrototype.visitOrderedItems in /lib/stringify.js E
A
isSingleQuotedAttributeCharacter in /lib/parse.js E
A
isDoubleQuotedAttributeCharacter in /lib/parse.js E
A
Configuration#getConfiguration in /lib/cli/configuration.js E
A
isUnquotedAttributeCharacter in /lib/parse.js E
A
compilerPrototype.setOptions in /lib/stringify.js E
A
visitors.footnoteDefinition in /lib/stringify.js E
A
visitors.footnoteReference in /lib/stringify.js E
A
compilerPrototype.compile in /lib/stringify.js E
A
renderFootnoteDefinition in /lib/parse.js E
A
visitors.imageReference in /lib/stringify.js E
A
isAlignmentRowCharacter in /lib/stringify.js E
A
compilerPrototype.block in /lib/stringify.js E
A
isUnclosedURLCharacter in /lib/parse.js E
A
isEnclosedURLCharacter in /lib/parse.js E
A
renderPedanticListItem in /lib/parse.js E
A
visitors.thematicBreak in /lib/stringify.js E
A
copyIdentifierEncoding in /lib/stringify.js E
A
visitors.linkReference in /lib/stringify.js E
A
getLocalConfiguration in /lib/cli/configuration.js E
A
compilerPrototype.all in /lib/stringify.js E
A
getUserConfiguration in /lib/cli/configuration.js E
A
renderNormalListItem in /lib/parse.js E
A
normalizeIdentifier in /lib/utilities.js E
A
visitors.definition in /lib/stringify.js E
A
visitors.inlineCode in /lib/stringify.js E
A
visitors.blockquote in /lib/stringify.js E
A
visitors.paragraph in /lib/stringify.js E
A
visitors.tableCell in /lib/stringify.js E
A
entityPrefixLength in /lib/stringify.js E
A
visitors.footnote in /lib/stringify.js E
A
visitors.listItem in /lib/stringify.js E
A
visitors.emphasis in /lib/stringify.js E
A
Parser#setOptions in /lib/parse.js E
A
startsWithEntity in /lib/stringify.js E
A
isInAlignmentRow in /lib/stringify.js E
A
visitors.heading in /lib/stringify.js E
A
locateInlineCode in /lib/parse.js E
A
renderBlockquote in /lib/parse.js E
A
validateBoolean in /lib/utilities.js E
A
visitors.strong in /lib/stringify.js E
A
isWordCharacter in /lib/parse.js E
A
visitors.delete in /lib/stringify.js E
A
tokenizeFactory in /lib/parse.js E
A
visitors.image in /lib/stringify.js E
A
validateNumber in /lib/utilities.js E
A
validateString in /lib/utilities.js E
A
descapeFactory in /lib/parse.js E
A
locateEmphasis in /lib/parse.js E
A
renderListItem in /lib/parse.js E
A
visitors.table in /lib/stringify.js E
A
renderFootnote in /lib/parse.js E
A
visitors.break in /lib/stringify.js E
A
locateDeletion in /lib/parse.js E
A
isAlphanumeric in /lib/stringify.js E
A
locateAutoLink in /lib/parse.js E
A
escapeFactory in /lib/stringify.js E
A
encodeFactory in /lib/stringify.js E
A
visitors.root in /lib/stringify.js E
A
visitors.text in /lib/stringify.js E
A
visitors.list in /lib/stringify.js E
A
visitors.yaml in /lib/stringify.js E
A
visitors.code in /lib/stringify.js E
A
visitors.html in /lib/stringify.js E
A
renderHeading in /lib/parse.js E
A
visitors.link in /lib/stringify.js E
A
encloseTitle in /lib/stringify.js E
A
isWhiteSpace in /lib/parse.js E
A
Parser#parse in /lib/parse.js E
A
renderInline in /lib/parse.js E
A
isAlphabetic in /lib/parse.js E
A
shouldIgnore in /lib/cli/ignore.js E
A
locateStrong in /lib/parse.js E
A
loadPatterns in /lib/cli/ignore.js E
A
isApplicable in /lib/cli/ignore.js E
A
locateEscape in /lib/parse.js E
A
renderParent in /lib/parse.js E
A
stateToggler in /lib/utilities.js E
A
locateBreak in /lib/parse.js E
A
toCamelCase in /lib/cli/cli.js E
A
renderBlock in /lib/parse.js E
A
parsePlugin in /lib/cli/cli.js E
A
locateLink in /lib/parse.js E
A
fileSystem in /lib/cli/file-pipeline/file-system.js E
A
renderVoid in /lib/parse.js E
A
encodeNoop in /lib/stringify.js E
A
extensions in /lib/cli/cli.js E
A
renderLink in /lib/parse.js E
A
parseJSON in /lib/cli/cli.js E
A
transform in /lib/cli/file-pipeline/transform.js E
A
stringify in /lib/cli/file-pipeline/stringify.js E
A
locateURL in /lib/parse.js E
A
isNumeric in /lib/parse.js E
A
locateTag in /lib/parse.js E
A
configure in /lib/cli/file-set-pipeline/configure.js E
A
configure in /lib/cli/file-pipeline/configure.js E
A
transform in /lib/cli/file-set-pipeline/transform.js E
A
getIndent in /lib/parse.js E
A
renderRaw in /lib/parse.js E
A
findRoot in /lib/cli/file-pipeline/configure.js E
A
traverse in /lib/cli/file-set-pipeline/file-system.js E
A
valueOf in /lib/cli/file-set.js E
A
options in /lib/cli/cli.js E
A
plugins in /lib/cli/cli.js E
A
engine in /lib/cli/index.js E
A
stdout in /lib/cli/file-pipeline/stdout.js E
A
label in /lib/stringify.js E
A
parse in /lib/cli/file-pipeline/parse.js E
A
clean in /lib/utilities.js E
A
match in /lib/cli/ignore.js E
A
match in /lib/cli/finder.js E
A
start in /lib/cli/spinner.js E
A
queue in /lib/cli/file-pipeline/queue.js E
A
load in /lib/cli/configuration.js E
A
load in /lib/cli/ignore.js E
A
read in /lib/cli/file-pipeline/read.js E
A
copy in /lib/cli/file-pipeline/copy.js E
A
find in /lib/cli/finder.js E
A
stop in /lib/cli/spinner.js E
A
pad in /lib/stringify.js E
A
use in /lib/cli/file-set.js E
A
add in /lib/cli/file-set.js E
A
one in /lib/cli/file-set.js E
A
tokenizeFootnoteDefinition in /lib/parse.js E
A
tokenizeYAMLFrontMatter in /lib/parse.js E
A
tokenizeThematicBreak in /lib/parse.js E
A
tokenizeLineHeading in /lib/parse.js E
A
tokenizeBlockquote in /lib/parse.js E
A
tokenizeDefinition in /lib/parse.js E
A
tokenizeInlineCode in /lib/parse.js E
A
tokenizeParagraph in /lib/parse.js E
A
tokenizeReference in /lib/parse.js E
A
tokenizeDeletion in /lib/parse.js E
A
tokenizeEmphasis in /lib/parse.js E
A
tokenizeAutoLink in /lib/parse.js E
A
tokenizeNewline in /lib/parse.js E
A
tokenizeHeading in /lib/parse.js E
A
tokenizeEscape in /lib/parse.js E
A
tokenizeFences in /lib/parse.js E
A
tokenizeStrong in /lib/parse.js E
A
tokenizeBreak in /lib/parse.js E
A
tokenizeTable in /lib/parse.js E
A
tokenizeList in /lib/parse.js E
A
tokenizeHTML in /lib/parse.js E
A
tokenizeText in /lib/parse.js E
A
tokenizeLink in /lib/parse.js E
A
tokenizeCode in /lib/parse.js E
A
tokenizeURL in /lib/parse.js E
A
tokenizeTag in /lib/parse.js E
A
merge in /lib/cli/configuration.js E
A
compilerPrototype.enterLinkReference in /lib/stringify.js E
A
eatHTMLProcessingInstruction in /lib/parse.js E
A
MERGEABLE_NODES.blockquote in /lib/utilities.js E
A
compilerPrototype.visit in /lib/stringify.js E
A
MERGEABLE_NODES.text in /lib/utilities.js E
A
eatHTMLDeclaration in /lib/parse.js E
A
removeIndentation in /lib/parse.js E
A
Parser#getIndent in /lib/parse.js E
A
{VFile}.locked in /lib/cli/file-set.js E
A
eatHTMLComment in /lib/parse.js E
A
Parser#indent in /lib/parse.js E
A
decodeFactory in /lib/parse.js E
A
eatHTMLCDATA in /lib/parse.js E
A
findPlugin in /lib/cli/file-pipeline/configure.js E
A
encloseURI in /lib/stringify.js E
A
runFactory in /lib/cli/file-pipeline/index.js E
A
mergeable in /lib/utilities.js E
A
writeAll in /lib/cli/watch-output-cache.js E
A
stdin in /lib/cli/file-set-pipeline/stdin.js E
A
given in /lib/cli/file-set-pipeline/log.js E
A
usage in /lib/cli/cli.js E
A
raise in /lib/utilities.js E
A
help in /lib/cli/cli.js E
A
run in /lib/cli/index.js E
A
log in /lib/cli/cli.js E
A
log in /lib/cli/file-set-pipeline/log.js E
A
add in /lib/cli/watch-output-cache.js E
A
eatHTMLOpeningTag in /lib/parse.js E
A
eatHTMLClosingTag in /lib/parse.js E
A
renderCodeBlock in /lib/parse.js E
A
use in /lib/cli/cli.js E
Proper documentation present
Please take a look
Undocumented

Let's raise the visibility of documentation in Open Source!

This page is for wooorm/remark and is part of a project called "Inch CI", showing documentation measurements provided by Inch. Inch CI also provides a badge: (not counting low priority objects)

Can I have my own badges?

Sure! To get the badge for the project you are looking at, just click the badge next to the project name.

To register another project with Inch CI, just enter your username/repo on the homepage or sign in with GitHub!

Can I tell Inch which files to evaluate?

No problemo! Learn how ...

Can I configure a webhook for continuous integration?

Of course! Learn how ...

What is the goal of this?

I really think that posting badges for documentation in READMEs will benefit you (because people can see that your project is well documented) and our community in general by improving the visibility of documentation.

Let's start a discussion, let's raise the visibility of documentation, let's talk.

Suggestions, feedback, critique: Hit me up on Twitter or via issue.