caisin/typst
1
0
Fork 0
mirror of https://github.com/typst/typst synced 2025-05-14 04:56:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

Reword CLI docs

Browse Source
This commit is contained in:
Laurenz 2023-07-04 16:47:57 +02:00
parent 224e1df8e5
commit 5fdd62141f
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
crates/typst-cli/src/args.rs
View File

@ -3,11 +3,11 @@ use std::path::PathBuf;
use clap::{ArgAction, Parser, Subcommand, ValueEnum}; use clap::{ArgAction, Parser, Subcommand, ValueEnum};
/// typst creates PDF files from .typ files /// The Typst compiler.
#[derive(Debug, Clone, Parser)] #[derive(Debug, Clone, Parser)]
#[clap(name = "typst", version = crate::typst_version(), author)] #[clap(name = "typst", version = crate::typst_version(), author)]
pub struct CliArguments { pub struct CliArguments {
/// The typst command to run /// The command to run
#[command(subcommand)] #[command(subcommand)]
pub command: Command, pub command: Command,
@ -21,15 +21,15 @@ pub struct CliArguments {
#[derive(Debug, Clone, Subcommand)] #[derive(Debug, Clone, Subcommand)]
#[command()] #[command()]
pub enum Command { pub enum Command {
/// Compiles the input file into a PDF file /// Compiles an input file into a PDF or PNG file
#[command(visible_alias = "c")] #[command(visible_alias = "c")]
Compile(CompileCommand), Compile(CompileCommand),
/// Watches the input file and recompiles on changes /// Watches an input file and recompiles on changes
#[command(visible_alias = "w")] #[command(visible_alias = "w")]
Watch(CompileCommand), Watch(CompileCommand),
/// List all discovered fonts in system and custom font paths /// Lists all discovered fonts in system and custom font paths
Fonts(FontsCommand), Fonts(FontsCommand),
} }
@ -42,11 +42,11 @@ pub struct CompileCommand {
/// Path to output PDF file or PNG file(s) /// Path to output PDF file or PNG file(s)
pub output: Option<PathBuf>, pub output: Option<PathBuf>,
/// Configure the project root /// Configures the project root
#[clap(long = "root", env = "TYPST_ROOT", value_name = "DIR")] #[clap(long = "root", env = "TYPST_ROOT", value_name = "DIR")]
pub root: Option<PathBuf>, pub root: Option<PathBuf>,
/// Add additional directories to search for fonts /// Adds additional directories to search for fonts
#[clap( #[clap(
long = "font-path", long = "font-path",
env = "TYPST_FONT_PATHS", env = "TYPST_FONT_PATHS",
@ -55,11 +55,11 @@ pub struct CompileCommand {
)] )]
pub font_paths: Vec<PathBuf>, pub font_paths: Vec<PathBuf>,
/// Opens the output file after compilation using the default PDF viewer /// Opens the output file using the default viewer after compilation
#[arg(long = "open")] #[arg(long = "open")]
pub open: Option<Option<String>>, pub open: Option<Option<String>>,
/// The PPI to use if exported as PNG /// The PPI (pixels per inch) to use for PNG export
#[arg(long = "ppi", default_value_t = 144.0)] #[arg(long = "ppi", default_value_t = 144.0)]
pub ppi: f32, pub ppi: f32,
@ -85,10 +85,10 @@ impl CompileCommand {
} }
} }
/// List all discovered fonts in system and custom font paths /// Lists all discovered fonts in system and custom font paths
#[derive(Debug, Clone, Parser)] #[derive(Debug, Clone, Parser)]
pub struct FontsCommand { pub struct FontsCommand {
/// Add additional directories to search for fonts /// Adds additional directories to search for fonts
#[clap( #[clap(
long = "font-path", long = "font-path",
env = "TYPST_FONT_PATHS", env = "TYPST_FONT_PATHS",
@ -97,7 +97,7 @@ pub struct FontsCommand {
)] )]
pub font_paths: Vec<PathBuf>, pub font_paths: Vec<PathBuf>,
/// Also list style variants of each font family /// Also lists style variants of each font family
#[arg(long)] #[arg(long)]
pub variants: bool, pub variants: bool,
} }