https://github.com/zheng-bote/digidocu_dev
digidocu is a rich web application that can be used to create complex, redundancy-free, multilingual documentation.
https://github.com/zheng-bote/digidocu_dev
angular cpp17 cpp20 qt qt5 qt6 rocket rust vue
Last synced: 5 months ago
JSON representation
digidocu is a rich web application that can be used to create complex, redundancy-free, multilingual documentation.
- Host: GitHub
- URL: https://github.com/zheng-bote/digidocu_dev
- Owner: Zheng-Bote
- Created: 2024-03-16T16:02:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:50:04.000Z (10 months ago)
- Last Synced: 2025-02-07T11:47:10.636Z (5 months ago)
- Topics: angular, cpp17, cpp20, qt, qt5, qt6, rocket, rust, vue
- Homepage: https://www.digidocu.dev/
- Size: 526 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
DigiDocuDev
RWA for maintenance of technical documentation
[Report Issue](https://github.com/Zheng-Bote/repo-template/issues) [Request Feature](https://github.com/Zheng-Bote/repo-template/pulls)
[](<[https://choosealicense.com/licenses/mit/](http://www.apache.org/licenses/LICENSE-2.0)>)
> \[!WARNING]
> README ist still under heavy construction.
**Table of Contents**
- [Description](#description)
- [Features](#features)
- [Status](#status)
- [Repo](#repo)
- [Readme](#readme)
- [Markdown files](#markdown-files)
- [Application](#application)
- [Installation](#installation)
- [Dependencies](#dependencies)
- [folder structure](#folder-structure)
- [Usage/Examples](#usageexamples)
- [API Reference](#api-reference)
- [Inputs](#inputs)
- [Outputs](#outputs)
- [Parameters](#parameters)
- [Documentation](#documentation)
- [Architecture](#architecture)
- [Product View](#product-view)
- [Process](#process)
- [Comments](#comments)
- [Screenshots](#screenshots)
- [Authors and License](#authors-and-license)
- [License](#license)
- [Authors](#authors)
- [Code Contributors](#code-contributors)
# Description
[digidocu](https://www.digidocu.dev/) 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
[](https://github.com/Zheng-Bote/digidocu_dev/actions/workflows/repo-create_tree_readme.yml)
[](https://github.com/Zheng-Bote/digidocu_dev/actions/workflows/repo-actions_docu.yml)
[](https://github.com/Zheng-Bote/digidocu_dev/actions/workflows/repo-call_Readme.yml)
### Markdown files
[](https://github.com/Zheng-Bote/digidocu_dev/actions/workflows/repo-create_doctoc_md.yml)
create ToC in Markdown files in folders
- .github/actions/\*\*
- .github/workflows/\*\*
- dist/\*\*
- docs/\*\*
### Application
> \[!CAUTION]
> [digidocu versions ≤ v2](https://www.digidocu.dev/architecture_v1-2.html) with QT5 | QT6 and Vanilla Javascript/Vue2 are outdated and deprecated.
> \[!NOTE]
> [digidocu versions ≥ v3](https://www.digidocu.dev/architecture_v3.html) 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
```HTML
under construction
```
# 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_ \ |
| `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](https://www.digidocu.dev/architecture_v3.html)
## Architecture
### Product View
### Process
## Comments
> \[!CAUTION]
> [digidocu versions ≤ v2](https://www.digidocu.dev/architecture_v1-2.html) with QT5 | QT6 and Vanilla Javascript/Vue2 are outdated and deprecated.
> \[!NOTE]
> [digidocu versions ≥ v3](https://www.digidocu.dev/architecture_v3.html) are based on Rust and Angular/Vue3 and still maintained.
## Screenshots
# Authors and License
## License
[](<[https://choosealicense.com/licenses/mit/](http://www.apache.org/licenses/LICENSE-2.0)>)
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
- [](https://www.github.com/Zheng-Bote)
### Code Contributors
[](https://www.github.com/Zheng-Bote)
:vulcan_salute: