update description

This commit is contained in:
Philipp Kunz 2024-05-29 14:12:44 +02:00
parent e703b918d7
commit 179ccd3883
2 changed files with 14 additions and 9 deletions

View File

@ -14,11 +14,11 @@
"buildDocs": "(tsdoc)" "buildDocs": "(tsdoc)"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.25", "@git.zone/tsbuild": "^2.1.25",
"@gitzone/tsbundle": "^2.0.5", "@git.zone/tsbundle": "^2.0.5",
"@gitzone/tsdoc": "^1.1.10", "@git.zone/tsdoc": "^1.1.10",
"@gitzone/tstest": "^1.0.44", "@git.zone/tstest": "^1.0.44",
"@pushrocks/tapbundle": "^5.0.3", "@push.rocks/tapbundle": "^5.0.3",
"@types/node": "^17.0.41" "@types/node": "^17.0.41"
}, },
"browserslist": [ "browserslist": [
@ -37,8 +37,8 @@
"readme.md" "readme.md"
], ],
"dependencies": { "dependencies": {
"@pushrocks/smartfile": "^10.0.2", "@push.rocks/smartfile": "^10.0.2",
"@pushrocks/smartmarkdown": "^3.0.0", "@push.rocks/smartmarkdown": "^3.0.0",
"@tsclass/tsclass": "^4.0.3" "@tsclass/tsclass": "^4.0.3"
}, },
"keywords": [ "keywords": [
@ -49,5 +49,10 @@
"sites", "sites",
"typescript", "typescript",
"development tool" "development tool"
] ],
"homepage": "https://code.foss.global/push.rocks/smartdocumentation",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/smartdocumentation.git"
}
} }

View File

@ -12,7 +12,7 @@ This will add `@push.rocks/smartdocumentation` to your project's dependencies.
## Usage ## Usage
The `@push.rocks/smartdocumentation` package allows you to map your git directory structures into documentation sites efficiently. It leverages TypeScript and a set of sophisticated tools under the hood such as `@pushrocks/smartfile`, `@pushrocks/smartmarkdown`, and `@tsclass/tsclass` to manage and generate documentation content dynamically. The `@push.rocks/smartdocumentation` package allows you to map your git directory structures into documentation sites efficiently. It leverages TypeScript and a set of sophisticated tools under the hood such as `@push.rocks/smartfile`, `@push.rocks/smartmarkdown`, and `@tsclass/tsclass` to manage and generate documentation content dynamically.
### Setting Up ### Setting Up