anydev/structured-wikivoyage-exports
2
0
Fork 0
mirror of https://github.com/bcye/structured-wikivoyage-exports.git synced 2025-09-18 19:04:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

add dockerfile and document

Browse Source
This commit is contained in:
Bruce Röttgers
2025-04-26 22:20:38 +02:00
parent 804ffeb82b
commit e606e45bf6
3 changed files with 20 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -2,8 +2,16 @@
Small utility to convert the wikitext data from the Wikivoyage dumps into a structured format. The goal is to make it easier to work with the data and extract useful information programmatically.
## Installation
## Usage
### Docker
This script is intended to be run with docker. A docker image is [available from the GitHub registry](). For example, you may run it using the filesystem handler with `docker run -e HANDLER=filesystem -e HANDLER_FILESYSTEM_OUTPUT_DIR=/output -v ./output:/output ghcr.io/bcye/structured-wikivoyage-exports`. For all the different options, refer to [the docs](docs).
### Types
TypeScript types for consuming the json output are available, you may install them from the [@bcye/structured-wikivoyage-types]() npm package. Refer to the included docstrings in [types/index.d.ts](types/index.d.ts) for reference.
## Documentation
See [docs](docs) for more information on how to use this utility.
See [docs](docs) for more information on how to use this utility.