Mkdocs material documentation #58
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
update some paths
Replace link paths to correct md path
bertsky
reviewed
Nov 30, 2022
docs/usage/overview.md
Outdated
Comment on lines
36
to
39
| - `CONTROLLER_MODELS=./ocrd/controller/models`: | ||
| - `$CONTROLLER_MODELS/ocrd-resources`: persistent storage directory for [processor resources](https://ocr-d.de/en/models) | ||
| - `CONTROLLER_CONFIG=./ocrd/controller/config`: | ||
| - `$CONTROLLER_CONFIG/ocrd/resources.yml`: persistent database for [processor resources](https://ocr-d.de/en/models) |
There was a problem hiding this comment.
Suggested change
| - `CONTROLLER_MODELS=./ocrd/controller/models`: | |
| - `$CONTROLLER_MODELS/ocrd-resources`: persistent storage directory for [processor resources](https://ocr-d.de/en/models) | |
| - `CONTROLLER_CONFIG=./ocrd/controller/config`: | |
| - `$CONTROLLER_CONFIG/ocrd/resources.yml`: persistent database for [processor resources](https://ocr-d.de/en/models) | |
| - `CONTROLLER_MODELS=./ocrd/controller/models`: | |
| - `$CONTROLLER_MODELS/ocrd-resources`: persistent storage directory for [processor resources](https://ocr-d.de/en/models) | |
| - `CONTROLLER_CONFIG=./ocrd/controller/config`: | |
| - `$CONTROLLER_CONFIG/ocrd/resources.yml`: persistent database for [processor resources](https://ocr-d.de/en/models) |
bertsky
reviewed
Nov 30, 2022
docs/usage/overview.md
Outdated
| to inspect results and workflows, and customise+rerun workflows. | ||
|
|
||
| Thus, only the latter two could be considered for "end users". |
There was a problem hiding this comment.
Suggested change
| Thus, only the latter two could be considered for "end users". | |
| Thus, only the latter two could be considered for "end users". |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR adds the mkdocs documentation of integration of OCR-D and Kitodo.
Besides the files of the documentation a script for converting .env file to context specific tables as md's and a workflow to build the documentation using mkdocs and the material theme and deploy to GitHub Pages is included.
https://slub.github.io/ocrd_kitodo/