build cli tool - Githubissues

charlesreid1 / translate-yer-docs

A pandoc tool to translate yer Markdown docs https://pages.charlesreid1.com/translate-yer-docs

MIT License

1 stars 0 forks source link

build cli tool #5

Open charlesreid1 opened 6 years ago

charlesreid1 commented 6 years ago

see how this repo is organized page for prototype

charlesreid1 commented 6 years ago

what information is needed

source docs directory
target docs directory
target translation language

what information is optional

are you running with mkdocs

charlesreid1 commented 6 years ago

no command line options

if the cli tool is run with no command line options, run through an interactive set of steps to ask the user for the information the program needs. Provide some sensible defaults.

charlesreid1 commented 6 years ago

source and target options

should be able to specify source and target directory on command line with --source and --target:

$ translate_the_docs --source=doc/ --target=ru_docs

charlesreid1 commented 6 years ago

language options

should be able to specify target language with --language:

$ translate_the_docs --source=doc/ --target=ru_docs --language=ru

charlesreid1 commented 6 years ago

mkdocs options

Should be able to specify that we are using mkdocs and we want to translate the page titles in mkdocs.yml:

$ translate_the_docs --source=doc/ --target=ru_docs --language=ru --mkdocs