question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[TechDocs] Support all mkdocs CLI options in techdocs-cli

See original GitHub issue

Feature Suggestion

mkdocs supports a number of additional command line options, only some of which are supported by the techdocs-cli. Instead of adding these one-by-one to the techdocs-cli, @iamEAP suggested that we just support all mkdocs CLI options in the techdocs-cli.

Possible Implementation

Commander (the library used in the techdocs-cli to parse CLI options) already supports the common -- syntax, to indicate the end of arguments that should be processed and the start or arguments that should be passed-through in some manner. This is enabled by default, it should just be a matter of passing these through to the underlying code as required.

Context

Specifically, as per #10604, I’d like to be able to use the --strict flag of mkdocs build

Issue Analytics

  • State:closed
  • Created a year ago
  • Reactions:2
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
andrewthauercommented, Jun 24, 2022

I would still like to see this happen. We have currently a wrapper CLI around techdocs-cli that does some additional features that are not supported now. Supporting add mkdocs flags would be a step towards us being able to deprecate our custom CLI. I might take a stab at this at some point, but not sure when I’ll be able to get to it.

0reactions
github-actions[bot]commented, Aug 23, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Read more comments on GitHub >

github_iconTop Results From Across the Web

TechDocs CLI · Backstage Software Catalog and Developer ...
TechDocs CLI - a utility command line interface for managing TechDocs sites in ... Generate TechDocs documentation site using mkdocs. publish [options] ...
Read more >
@techdocs/cli - npm
Utility CLI for managing TechDocs sites in Backstage.. Latest version: 1.2.4, last published: 3 days ago. Start using @techdocs/cli in your ...
Read more >
[TechDocs] Support mkdocs strict mode in CLI generate ...
A new flag on techdocs-cli generate , effectively a passthrough to the --strict flag in the underlying build command. Context. The context here ......
Read more >
Roadie on Twitter: " techdocs-cli A command line interface for ...
techdocs This is a frontend Backstage plugin which requests docs from techdocs-backend and displays them in the UI so you can read them....
Read more >
Configuration - MkDocs
Guide to all available configuration settings. ... You can specify another path for it by using the -f / --config-file option (see mkdocs...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found