first pass at raw, text files

This commit is contained in:
2023-05-06 14:31:28 -07:00
parent a936a2a32f
commit 4061b40eb4
11 changed files with 4675 additions and 7 deletions

View File

@@ -0,0 +1,34 @@
## Install from npm
```bash
# Update project npm config to refer to correct registry for the @doc-utils scope
echo '@doc-utils:registry=https://gitea.jbrumond.me/api/packages/doc-utils/npm/' >> ./.npmrc
# Install package for programatic use
npm install --save @doc-utils/docs2website
# Install globally for CLI usage
npm install --global @doc-utils/docs2website
```
## Building from source
```bash
npm run tsc
```
## Command Line Use
```
docs2website <config file>
```
### Config File
See [./sample-config.yaml](./sample-config.yaml)