villawebs.blogg.se - Duly noted rather be

#Duly noted rather be how to#
#Duly noted rather be generator#
#Duly noted rather be full#
#Duly noted rather be code#

A reference parser that parses all the links and anchors in your code - the output of which is two reference maps:.

This code is generally organized into a three parts: These docs are rendered in GitHub at /docs. Examplesįor this project, markdown docs were generated from our typescript source code. The real power is in adding links to the external services you or your team use. When you initialize Duly Noted, the provided example duly-noted.json file will contain external reference examples for:

This means you can link to that complicated GitHub issue conversation simply with see !issue/2. You can link to your scrum manager, your ticket system, GitHub, anywhere on the Internet or your Intranet that uses URLs with GUID-type patterning (so basically everywhere.), without cluttering your source control with lengthy, You can define external reference patterns in your duly-noted.json in the format:Īdding an external link to a comment works just like adding an internal link - with one major change - the :: in external reference path will be replace in order by items in the link.įor example, using in a comment will link to:

#Duly noted rather be how to#

If you have an idea of how to better handle this anchor business please leave a comment on Issue #4. Note that BitBucket does not currently support html inline, so you are best to just set these both to false and add your voice to the legion of folks who requested they support some basic html in Markdown docs. If you would rather not muddle your Markdown with 's at all then set both to false, and anchors will not be modified, but simply printed out. To insert plain-jane HTML tags as anchors set markdownGeneratorOptions.htmlAnchors = true. To insert tags that will work as anchors in GitHub set markdownGeneratorOptions.gitHubHtmlAnchors = true in your duly-noted.json file. Supports 's as HTML in-line with the Markdown.

Markdown does not natively support the creation of such anchors, however, there are some work-arounds if you are hosting (rendering) on GitHub, or your viewer You can link to another place in your source comments as follows: Set to true to insert html anchor tags in your markdown to support "#" links.ĭuly Noted allows you to create both internal and external links. Only use if you are hosting docs in GitHub. Set to true to support anchor tags in GitHub.

#Duly noted rather be generator#

Object for setting specific settings for Markdown Generator If you want to leave these files undeleted, set this to true. When it is done, it cleans up these json files automatically. Currently html and markdown are available.ĭuly Noted parses your code files to a json map of comments and code. The default link start is so to link to anchor above: of External Reference objects, each with an anchor and a path.Īrray of generators you want to use to generate output. The regular expression to use to identify links. The default anchor start is !, as in !ImAnAnchor The regular expression to use to identify anchors you want to be able to link to. For markdown + GitHub README.md can be helpful, as it auto-renders.ĭirectory where documentation should be output. Output documentation index/homepage name. The input code files you want to document with Duly Noted.

See the docs for this project in action here -> Duly Noted DocsĬonfig Settings, and Default Values SettingĪ name for your project - used by generator for headings.Īrray of file globs.

Produce documents that are easy to host auto magically in git tools (i.e., GitHub, BitBucket).

Support long-form and short-form comments in many different languages:.

Produce "Literate Programming" code style documentation that is easy to read and understand.

Link externally to wikis, tickets, tasks, issues, Stackoverflow questions - you name it.

Link internally between places in comments with simple, clean notation.

Output documentation in easy to display/render/share formats:.

We spent a lot of time writing comments and running document generators - all to produce less-than-useful documentation

#Duly noted rather be full#

We tried a bunch of tools before we set out to write our own, but none of them had the full set of features we needed. The goal of this project is to provide an easy, flexible way to comment source code, leveraging links!