Domaindoc

screenshot of Domaindoc

:ocean: Documentation tool for domain models

Overview:

CircleCIcodecov is a static site generator for creating documentation sites of domain models using markdown and yaml syntax. It is a JavaScript CLI tool that allows users to write markdown files for models and generate HTML documentation files. The tool is configurable through a .domaindoc.yml file and provides features such as model and property descriptions, source code URLs, and an interactive editing interface. CircleCIcodecov is an open-source software licensed under the MIT License.

Features:

  • Static Site Generation: CircleCIcodecov allows users to create documentation sites for their domain models using markdown and yaml syntax.
  • Model Descriptions: Users can provide descriptions for their models, including name, type, labels, description, source code URL, and an edit page URL.
  • Property Descriptions: Users can define properties for their models, including name, type, and description.
  • Configurability: CircleCIcodecov can be configured through a .domaindoc.yml file, allowing users to specify the destination directory, source directory, document title, development server port number, basepath, and logger title.

Summary:

CircleCIcodecov is a JavaScript CLI tool that enables users to create documentation sites for their domain models using markdown and yaml syntax. It provides features such as model and property descriptions, source code URLs, and an interactive editing interface. The tool is configurable through a .domaindoc.yml file, allowing users to customize various aspects of the generated documentation. CircleCIcodecov is an open-source software licensed under the MIT License.