notatio

Table of contents

• Summary
• Installation
• Usage
  • Manual
  • Subcommands
  • Docker
• Development
• Packages
• Third party software
• Dependencies
  • Graph
  • Licenses
• License

Summary

A tool designed to streamline working with documentation and diagrams.

Installation

To install the package, run make install (directly from the repository clone) or use go install github.com/codemityio/notatio@latest.

Some of the tools depend on additional commands such as dot, mmdc, java or chromium-browser. If any of these are missing, you will be notified when using the tools. For the most seamless experience, we recommend using the containerized version of this tool.

Usage

Once installed, use the notatio command to get started.

Manual

$ notatio --help
NAME:
   notatio - A new cli application

USAGE:
   notatio [global options] command [command options]

VERSION:
   latest

DESCRIPTION:
   A tool designed to streamline working with documentation and diagrams.

AUTHOR:
   codemityio

COMMANDS:
   coi       
   fs        
   graphviz  
   mermaid   
   plantuml  
   toc       
   tol       
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

COPYRIGHT:
   codemityio

Subcommands

• coi - A simple tool to generate document sections with provided command output.
• fs - A tool for scanning and analysing the file system.
• graphviz - A CLI tool that wraps https://gitlab.com/graphviz/graphviz to convert dot/gv files to svg/png images.
• mermaid - A CLI tool that wraps https://github.com/mermaid-js/mermaid-cli to convert mmd files to svg/png images.
• plantuml - A CLI tool that wraps https://github.com/plantuml/plantuml to convert puml files to svg/png images.
• toc - A tool to generate table of contents section within a Markdown file from a list of paths or headers found in a document.
• tol - A simple tool to generate a table of licenses from go-licenses output.

Docker

$ docker run codemityio/notatio

Development

To work with the codebase, use make command as the primary entry point for all project tools.

Use the arrow keys ↓ ↑ → ← to navigate the options, and press / to toggle search.

Run make cmd COMMAND="make check" before raising a PR to ensure all checks pass in the CI environment.

Packages

Third party software

The Docker image is based on https://github.com/codemityio/dbi which includes the following third-party components.

• PlantUML (https://plantuml.com) — licensed under GPL v3 https://github.com/plantuml/plantuml/blob/master/license.txt - no modifications made.

• Graphviz (https://graphviz.org) — licensed under EPL v1.0 https://gitlab.com/graphviz/graphviz/-/blob/main/LICENSE - no modifications made.

• Mermaid (https://mermaid.js.org) — licensed under MIT. Copyright (c) 2014-2024 Knut Sveidqvist - no modifications made.

Dependencies

Graph

Licenses

License

This project is licensed under the MIT License. See the LICENSE file for details.