Report Issue Request Feature

[!WARNING] README ist still under heavy construction.

Table of Contents

• Description
  • Features
  • Status
    • Repo
    • Readme
    • Markdown files
    • Application
• Installation
  • Dependencies
  • folder structure
  • Usage/Examples
• API Reference
  • Inputs
  • Outputs
  • Parameters
• Documentation
  • Architecture
    • Product View
    • Process
  • Comments
  • Screenshots
• Authors and License
  • License
  • Authors
    • Code Contributors

Description

digidocu is a rich web application that can be used to create redundancy-free, multilingual documentation.

Optimized for maintenance of technical documentation.

Features

• [x] Apache license v2.0
• [x] works as designed
• [ ] no bugs
• [x] some more or less usefull Github Actions

Status

Repo

Readme

Markdown files

create ToC in Markdown files in folders

• .github/actions/**
• .github/workflows/**
• dist/**
• docs/**

Application

[!CAUTION] digidocu versions ≤ v2 with QT5 | QT6 and Vanilla Javascript/Vue2 are outdated and deprecated.

[!NOTE] digidocu versions ≥ v3 are based on Rust and Angular/Vue3 and still maintained.

Installation

bla bla ... everything easy and green with No Code/Low code and without any costs

Dependencies

bla bla ... with a little help from my friends

folder structure

.
├── .github
│   ├── actions
│   │   └── doctoc
│   │       ├── README.md
│   │       ├── action.yml
│   │       └── dist
│   │           ├── index.js
│   │           ├── index.js.map
│   │           ├── licenses.txt
│   │           └── sourcemap-register.js
│   └── workflows
│       ├── repo-actions_docu.yml
│       ├── repo-call_Readme.yml
│       ├── repo-create_doctoc.yml_
│       ├── repo-create_doctoc_md.yml
│       └── repo-create_tree_readme.yml
├── README.md
├── docs
│   └── img
│       ├── functional_process_current.png
│       └── product_view_current.png
├── src
│   └── .gitkeep
└── tree.bak

8 directories, 16 files

Usage/Examples

bla bla ... usage is intuitive and runs mostly automatically with no needs of any knowledge

<mark> under construction </mark>

API Reference

Inputs/Outputs will be filled automatically by .github/workflows/repo-actions_docu.yml

Inputs

Outputs

Parameters

Workflow or program

Parameter	Type	Description
name	string	Optional name-of-copyright-holder
created	string	Optional
version	string	Optional <v0.0.0>
link_left	string	Optional link-to-contact-page
link_right	string	Optional link-to-legal-notice-page

Documentation

see also: https://www.digidocu.dev/architecture_v3.html

Architecture

Product View

Process

Comments

[!CAUTION] digidocu versions ≤ v2 with QT5 | QT6 and Vanilla Javascript/Vue2 are outdated and deprecated.

[!NOTE] digidocu versions ≥ v3 are based on Rust and Angular/Vue3 and still maintained.

Screenshots

Authors and License

License

Copyright (c) 2019 ZHENG Robert

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and limitations under the License.

Authors

• 

Code Contributors

🖖