Table of Contents - metanorma-cli-1.4.16 Documentation
Pages
- CODE_OF_CONDUCT
- LICENSE
-
README.adoc
- Metanorma command-line interface (CLI)
- Installation
- Usage
- Setting up
- Generate a new Metanorma document using a template (`metanorma new`)
- Generate a new document from an official Metanorma template (from an official Metanorma template repository)
- Generate a new document from a custom Metanorma template repository
- Compile a document (`metanorma compile` or just `metanorma`)
- Compile a document collection (`metanorma collection`)
- List supported doctypes (`metanorma list-doctypes`)
- List supported output formats (`metanorma list-extensions`)
- Show processor version (`metanorma version`)
- Add new template repository (`metanorma template-repo add`)
- Generate metanorma minisite
- Using with proxy
- Credits
- License
Classes and Modules
- Array
- Hash
- Metanorma
- Metanorma::Cli
- Metanorma::Cli::Command
- Metanorma::Cli::Commands
- Metanorma::Cli::Commands::Config
- Metanorma::Cli::Commands::Site
- Metanorma::Cli::Commands::TemplateRepo
- Metanorma::Cli::Compiler
- Metanorma::Cli::Errors
- Metanorma::Cli::Errors::DuplicateTemplateError
- Metanorma::Cli::Errors::FileNotFoundError
- Metanorma::Cli::Errors::InvalidManifestFileError
- Metanorma::Cli::Generator
- Metanorma::Cli::GitTemplate
- Metanorma::Cli::SiteGenerator
- Metanorma::Cli::TemplateRepo
- Metanorma::Cli::ThorWithConfig
- Metanorma::Cli::UI
- Metanorma::Flavor
Methods
- ::activate — Metanorma::Flavor
- ::add — Metanorma::Cli::TemplateRepo
- ::ask — Metanorma::Cli::UI
- ::base_templates_path — Metanorma::Cli
- ::compile — Metanorma::Cli::Compiler
- ::config_path — Metanorma::Cli
- ::debug — Metanorma::Cli::UI
- ::download — Metanorma::Cli::GitTemplate
- ::error — Metanorma::Cli::UI
- ::exit_on_failure? — Metanorma::Cli::Commands::Config
- ::find_command — Metanorma::Cli
- ::find_or_download_by — Metanorma::Cli::GitTemplate
- ::generate — Metanorma::Cli::SiteGenerator
- ::global_config_path — Metanorma::Cli
- ::home_directory — Metanorma::Cli
- ::info — Metanorma::Cli::UI
- ::load_configs — Metanorma::Cli::Commands::Config
- ::load_flavors — Metanorma::Flavor
- ::load_flavors — Metanorma::Cli
- ::local_config_path — Metanorma::Cli
- ::new — Metanorma::Cli::Compiler
- ::new — Metanorma::Cli::Generator
- ::new — Metanorma::Cli::GitTemplate
- ::new — Metanorma::Cli::SiteGenerator
- ::new — Metanorma::Cli::TemplateRepo
- ::root — Metanorma::Cli
- ::root_path — Metanorma::Cli
- ::run — Metanorma::Cli::Generator
- ::run — Metanorma::Cli::UI
- ::say — Metanorma::Cli::UI
- ::start — Metanorma::Cli
- ::table — Metanorma::Cli::UI
- ::templates_path — Metanorma::Cli
- ::writable_templates_path? — Metanorma::Cli
- #activate — Metanorma::Flavor
- #add — Metanorma::Cli::Commands::TemplateRepo
- #add — Metanorma::Cli::TemplateRepo
- #add_new_template — Metanorma::Cli::TemplateRepo
- #all_type_extensions — Metanorma::Cli::Command
- #ask_to_confirm — Metanorma::Cli::Generator
- #backend_processors — Metanorma::Cli::Command
- #backend_version — Metanorma::Cli::Command
- #base_templates — Metanorma::Cli::Generator
- #build_asset_output_directory — Metanorma::Cli::SiteGenerator
- #build_collection_file — Metanorma::Cli::SiteGenerator
- #build_template_hash — Metanorma::Cli::Generator
- #build_templates_path — Metanorma::Cli::GitTemplate
- #clone_git_template — Metanorma::Cli::GitTemplate
- #collection — Metanorma::Cli::Command
- #compile — Metanorma::Cli::Command
- #compile — Metanorma::Cli::Compiler
- #compile — Metanorma::Cli::SiteGenerator
- #compile_document — Metanorma::Cli::Command
- #compile_file — Metanorma::Cli::Compiler
- #config_from_manifest — Metanorma::Cli::SiteGenerator
- #convert_to_html_page — Metanorma::Cli::SiteGenerator
- #create_directory_if_not_present! — Metanorma::Cli::SiteGenerator
- #create_file — Metanorma::Cli::Generator
- #create_metanorma_document — Metanorma::Cli::Generator
- #create_new_document — Metanorma::Cli::Command
- #create_template_config — Metanorma::Cli::TemplateRepo
- #custom_template — Metanorma::Cli::Generator
- #customize_options — Metanorma::Cli::Compiler
- #deep_set — Metanorma::Cli::Commands::Config
- #deep_unset — Metanorma::Cli::Commands::Config
- #default_config — Metanorma::Cli::SiteGenerator
- #dig_path — Metanorma::Cli::Commands::Config
- #dir_files — Metanorma::Cli::Generator
- #document_path — Metanorma::Cli::Generator
- #download — Metanorma::Cli::GitTemplate
- #download_template — Metanorma::Cli::GitTemplate
- #ensure_site_asset_directory! — Metanorma::Cli::SiteGenerator
- #extension_option — Metanorma::Cli::Compiler
- #extract_config_data — Metanorma::Cli::SiteGenerator
- #extract_option — Metanorma::Cli::Compiler
- #file_creation_message — Metanorma::Cli::Generator
- #filter_compile_options — Metanorma::Cli::ThorWithConfig
- #find_backend — Metanorma::Cli::Command
- #find_or_download — Metanorma::Cli::GitTemplate
- #find_realpath — Metanorma::Cli::SiteGenerator
- #find_standard_template — Metanorma::Cli::Generator
- #find_template — Metanorma::Cli::GitTemplate
- #flavors — Metanorma::Flavor
- #gem_loading_error — Metanorma::Flavor
- #generate — Metanorma::Cli::Commands::Site
- #generate — Metanorma::Cli::SiteGenerator
- #get — Metanorma::Cli::Commands::Config
- #git_repos — Metanorma::Cli::GitTemplate
- #join_keys — Metanorma::Cli::Command
- #list_doctypes — Metanorma::Cli::Command
- #list_extensions — Metanorma::Cli::Command
- #load_config — Metanorma::Cli::Commands::Config
- #load_flavors — Metanorma::Flavor
- #load_flavours — Metanorma::Cli::Command
- #manifest — Metanorma::Cli::SiteGenerator
- #manifest_config — Metanorma::Cli::SiteGenerator
- #new — Metanorma::Cli::Command
- #normalize_special_options — Metanorma::Cli::Compiler
- #options — Metanorma::Cli::ThorWithConfig
- #overwrite? — Metanorma::Cli::Generator
- #permission_missing_error — Metanorma::Cli::Generator
- #print_doctypes_table — Metanorma::Cli::Command
- #remove! — Metanorma::Cli::GitTemplate
- #remove_template — Metanorma::Cli::GitTemplate
- #run — Metanorma::Cli::Generator
- #save_config — Metanorma::Cli::Commands::Config
- #save_default_config — Metanorma::Cli::Commands::Config
- #select_source_files — Metanorma::Cli::SiteGenerator
- #select_wildcard_documents — Metanorma::Cli::Command
- #serialize — Metanorma::Cli::Compiler
- #serialize_options — Metanorma::Cli::Compiler
- #set — Metanorma::Cli::Commands::Config
- #single_type_extensions — Metanorma::Cli::Command
- #source_from_manifest — Metanorma::Cli::SiteGenerator
- #stringify_all_keys — Array
- #stringify_all_keys — Hash
- #supported_backends — Metanorma::Cli::Command
- #symbolize_all_keys — Array
- #symbolize_all_keys — Hash
- #template_config_file — Metanorma::Cli::TemplateRepo
- #template_data — Metanorma::Cli::SiteGenerator
- #template_path — Metanorma::Cli::GitTemplate
- #templates — Metanorma::Cli::TemplateRepo
- #templates_path — Metanorma::Cli::GitTemplate
- #try_convert_to_bool — Metanorma::Cli::Commands::Config
- #type_specific_template — Metanorma::Cli::Generator
- #unset — Metanorma::Cli::Commands::Config
- #validate_file_path — Metanorma::Cli::Compiler
- #version — Metanorma::Cli::Command
- #write_to_template_config — Metanorma::Cli::TemplateRepo