DocfxMultilanguageWithCli 1.0.0
dotnet new install DocfxMultilanguageWithCli::1.0.0
This package contains a .NET Template Package you can call from the shell/command line.
CLI for docfx multilanguage setup
Cli scripts work from root folder of a project. They are meant to be run using format like this: ./cli/documentation<command>
Commands in the CLI:
documentation_init -
- Installs necessary dotnet tools globaly, tools to install a configured in _cli/config.json.
- Creates docfx setup.
- Uses language setup from: _cli/config.json.
documentation_publish -
- Builds a documentation site to folder specified in docfx.json.
- Uses linting cli tool, outputs it's contents.
- Generates table of contents.
documentation_serve -
- Builds and serves documentation site on localhost.
- Uses linting cli tool, outputs it's contents.
- Generates table of contents.
documentation_translate_missing_mds -
- Doesn't translate anything by default, requires configuring.
- Can' be configuerd to use azure services to generate and translate missing .md files.
To run scripts you'll need to set execution policy, or digitaly sign .ps1 scripts.
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
Documentation for tools configured in this template :
- Docfx : https://dotnet.github.io/docfx/index.html
- Companion cli tools : https://github.com/Ellerbach/docfx-companion-tools
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last Updated |
---|---|---|
1.0.0 | 151 | 6/21/2024 |