API for pkgdown
Make Static HTML Documentation for a Package
| Global functions | |
|---|---|
| .rlang_as_friendly_type | Source code |
| .rlang_check_is_string | Source code |
| .rlang_stop_unexpected_typeof | Source code |
| .stop_not_number | Source code |
| `[.tag` | Source code |
| `as_html.#ifdef` | Source code |
| `as_html.#ifndef` | Source code |
| a | Source code |
| activate_navbar | Source code |
| add_missing_sss | Source code |
| all_sign | Source code |
| anchor_html | Source code |
| article_index | Source code |
| article_is_intro | Source code |
| article_redirects | Source code |
| as_data | Source code |
| as_data.NULL | Source code |
| as_data.tag_arguments | Source code |
| as_data.tag_author | Source code |
| as_data.tag_description | Source code |
| as_data.tag_details | Source code |
| as_data.tag_format | Source code |
| as_data.tag_note | Source code |
| as_data.tag_references | Source code |
| as_data.tag_section | Source code |
| as_data.tag_seealso | Source code |
| as_data.tag_source | Source code |
| as_data.tag_usage | Source code |
| as_data.tag_value | Source code |
| as_example | Source code |
| as_example.COMMENT | Source code |
| as_example.RCODE | Source code |
| as_example.tag | Source code |
| as_example.tag_dontrun | Source code |
| as_example.tag_dontshow | Source code |
| as_example.tag_donttest | Source code |
| as_example.tag_dots | Source code |
| as_example.tag_if | Source code |
| as_example.tag_ifelse | Source code |
| as_example.tag_out | Source code |
| as_example.tag_testonly | Source code |
| as_html | Source code |
| as_html.COMMENT | Source code |
| as_html.Rd | Source code |
| as_html.TEXT | Source code |
| as_html.USERMACRO | Source code |
| as_html.character | Source code |
| as_html.tag | Source code |
| as_html.tag_R | Source code |
| as_html.tag_S3method | Source code |
| as_html.tag_S4method | Source code |
| as_html.tag_Sexpr | Source code |
| as_html.tag_code | Source code |
| as_html.tag_cr | Source code |
| as_html.tag_deqn | Source code |
| as_html.tag_describe | Source code |
| as_html.tag_dots | Source code |
| as_html.tag_email | Source code |
| as_html.tag_enc | Source code |
| as_html.tag_enumerate | Source code |
| as_html.tag_eqn | Source code |
| as_html.tag_figure | Source code |
| as_html.tag_href | Source code |
| as_html.tag_if | Source code |
| as_html.tag_ifelse | Source code |
| as_html.tag_item | Source code |
| as_html.tag_itemize | Source code |
| as_html.tag_ldots | Source code |
| as_html.tag_link | Source code |
| as_html.tag_linkS4class | Source code |
| as_html.tag_method | Source code |
| as_html.tag_newcommand | Source code |
| as_html.tag_out | Source code |
| as_html.tag_preformatted | Source code |
| as_html.tag_renewcommand | Source code |
| as_html.tag_special | Source code |
| as_html.tag_subsection | Source code |
| as_html.tag_tab | Source code |
| as_html.tag_tabular | Source code |
| as_html.tag_url | Source code |
| as_pkgdown | Man page Source code |
| author_desc | Source code |
| author_list | Source code |
| author_name | Source code |
| auto_quote | Source code |
| autolink_html | Man page Source code |
| autolink_license | Source code |
| badges_extract | Source code |
| badges_extract_text | Source code |
| bib_paths | Source code |
| block_tag_to_comment | Source code |
| bs4_index_data | Source code |
| bs_theme | Source code |
| bs_theme_deps_suppress | Source code |
| bs_theme_rules | Source code |
| bst_paths | Source code |
| build_404 | Source code |
| build_article | Man page Source code |
| build_articles | Man page Source code |
| build_articles_index | Man page Source code |
| build_bslib | Source code |
| build_citation_authors | Source code |
| build_docsearch_json | Source code |
| build_favicons | Man page Source code |
| build_github_pages | Source code |
| build_home | Man page Source code |
| build_home_index | Man page Source code |
| build_home_license | Source code |
| build_home_md | Source code |
| build_news | Man page Source code |
| build_news_multi | Source code |
| build_news_single | Source code |
| build_quarto_articles | Source code |
| build_redirect | Source code |
| build_redirects | Man page Source code |
| build_reference | Man page Source code |
| build_reference_index | Man page Source code |
| build_reference_topic | Source code |
| build_rmarkdown_article | Source code |
| build_search | Man page Source code |
| build_search_index | Source code |
| build_site | Man page Source code |
| build_site_external | Source code |
| build_site_github_pages | Man page Source code |
| build_site_local | Source code |
| build_site_meta | Source code |
| build_sitemap | Source code |
| build_tutorials | Man page Source code |
| cache_cli_colours | Source code |
| cached_dependency | Source code |
| can_parse | Source code |
| capitalise | Source code |
| check_arg | Source code |
| check_bool | Source code |
| check_bootstrap_version | Source code |
| check_bslib_theme | Source code |
| check_built_site | Source code |
| check_call | Source code |
| check_character | Source code |
| check_closure | Source code |
| check_contents | Source code |
| check_data_frame | Source code |
| check_dest_is_pkgdown | Source code |
| check_environment | Source code |
| check_favicons | Source code |
| check_formula | Source code |
| check_function | Source code |
| check_integrity | Source code |
| check_logical | Source code |
| check_made_by | Source code |
| check_missing_images | Source code |
| check_missing_topics | Source code |
| check_name | Source code |
| check_number_decimal | Source code |
| check_number_whole | Source code |
| check_open_graph | Source code |
| check_open_graph_list | Source code |
| check_pkgdown | Man page Source code |
| check_string | Source code |
| check_symbol | Source code |
| check_theme | Source code |
| check_urls | Source code |
| ci_commit_sha | Source code |
| citation_auto | Source code |
| citation_provided | Source code |
| clean_cache | Man page Source code |
| clean_site | Man page Source code |
| cname_url | Source code |
| compute_hash | Source code |
| config_abort | Source code |
| config_abort_type | Source code |
| config_check_bool | Source code |
| config_check_character | Source code |
| config_check_list | Source code |
| config_check_number_whole | Source code |
| config_check_string | Source code |
| config_math_rendering | Source code |
| config_message | Source code |
| config_pluck | Source code |
| config_pluck_bool | Source code |
| config_pluck_character | Source code |
| config_pluck_external_articles | Source code |
| config_pluck_list | Source code |
| config_pluck_markdown_block | Source code |
| config_pluck_markdown_inline | Source code |
| config_pluck_number_whole | Source code |
| config_pluck_redirects | Source code |
| config_pluck_reference | Source code |
| config_pluck_sidebar_components | Source code |
| config_pluck_string | Source code |
| config_warn | Source code |
| construct_commit_message | Source code |
| context_get | Source code |
| context_set | Source code |
| context_set_scoped | Source code |
| convert_markdown_to_html | Source code |
| copy_article_images | Source code |
| copy_asset_dir | Source code |
| copy_assets | Source code |
| copy_favicons | Source code |
| copy_figures | Source code |
| copy_logo | Source code |
| cran_link | Source code |
| cran_unquote | Source code |
| create_citation_meta | Source code |
| data_article | Source code |
| data_articles | Source code |
| data_articles_index | Source code |
| data_articles_index_section | Source code |
| data_authors | Source code |
| data_citations | Source code |
| data_deps | Source code |
| data_deps_path | Source code |
| data_footer | Source code |
| data_home | Source code |
| data_home_sidebar | Source code |
| data_home_sidebar_authors | Source code |
| data_home_sidebar_citation | Source code |
| data_home_sidebar_license | Source code |
| data_home_sidebar_links | Source code |
| data_home_toc | Source code |
| data_navbar | Source code |
| data_news | Source code |
| data_open_graph | Source code |
| data_quarto_article | Source code |
| data_redirects | Source code |
| data_reference_index | Source code |
| data_reference_index_rows | Source code |
| data_reference_topic | Source code |
| data_template | Man page Source code |
| dedent | Source code |
| default_articles_index | Source code |
| default_reference_index | Source code |
| default_roles | Source code |
| default_sidebar_structure | Source code |
| deploy_site_github | Man page Source code |
| deploy_to_branch | Man page Source code |
| describe_contents | Source code |
| dest_files | Source code |
| dev_mode | Source code |
| dev_mode_auto | Source code |
| devtools_meta | Source code |
| dir_copy_to | Source code |
| dir_depth | Source code |
| dont_index | Source code |
| error_to_sitrep | Source code |
| escape_html | Source code |
| examples_env | Source code |
| ext_topics | Source code |
| external_dependencies | Source code |
| fig_opts_chunk | Source code |
| fig_save | Source code |
| fig_save_args | Source code |
| fig_settings | Man page Source code |
| file_copy_to | Source code |
| file_digest | Source code |
| file_equal | Source code |
| file_search_index | Source code |
| find_deps | Source code |
| find_icon | Source code |
| find_icons | Source code |
| find_logo | Source code |
| find_template | Source code |
| find_tutorials | Source code |
| flatten_ex | Source code |
| flatten_para | Source code |
| flatten_text | Source code |
| footnote_components | Source code |
| footnote_structure | Source code |
| format_author_name | Source code |
| fun_info | Source code |
| fun_name | Source code |
| get_bootstrap_version | Source code |
| get_bslib_theme | Source code |
| get_dir | Source code |
| get_h | Source code |
| get_headings | Source code |
| get_rd_from_help | Source code |
| get_section_level | Source code |
| get_site_paths | Source code |
| get_version | Source code |
| gha_current_branch | Source code |
| git | Source code |
| git_current_branch | Source code |
| git_has_remote_branch | Source code |
| github_push | Source code |
| github_worktree_add | Source code |
| github_worktree_remove | Source code |
| has_citation | Source code |
| has_class | Source code |
| has_coc | Source code |
| has_contributing | Source code |
| has_favicons | Source code |
| has_internet | Source code |
| has_logo | Source code |
| has_news | Source code |
| has_support | Source code |
| highlight_examples | Source code |
| highlight_path | Source code |
| highlight_styles | Source code |
| highlight_text | Source code |
| html_tag | Source code |
| in_pkgdown | Man page Source code |
| indent | Source code |
| index | Man page |
| init_site | Man page Source code |
| invert_index | Source code |
| is_handled_section | Source code |
| is_heading | Source code |
| is_infix | Source code |
| is_internal_link | Source code |
| is_newline | Source code |
| is_pkgdown | Source code |
| is_syntactic | Source code |
| is_testing | Source code |
| is_whitespace | Source code |
| is_wrapped_pre | Source code |
| licenses_db | Source code |
| link_url | Source code |
| linkify | Source code |
| local_context_eval | Source code |
| local_envvar_pkgdown | Source code |
| local_options_link | Source code |
| local_path | Source code |
| local_texi2dvi_envvars | Source code |
| logo_path | Source code |
| made_by_pkgdown | Source code |
| markdown_body | Source code |
| markdown_path_html | Source code |
| markdown_text | Source code |
| markdown_text_block | Source code |
| markdown_text_inline | Source code |
| markdown_to_html | Source code |
| match_env | Source code |
| match_fun | Source code |
| math_dependency | Source code |
| menu_heading | Source code |
| menu_icon | Source code |
| menu_link | Source code |
| menu_links | Source code |
| menu_search | Source code |
| menu_separator | Source code |
| menu_submenu | Source code |
| menu_theme | Source code |
| menu_type | Source code |
| meta_development | Source code |
| meta_figures | Source code |
| method_usage | Source code |
| modify_list | Source code |
| navbar_articles | Source code |
| navbar_components | Source code |
| navbar_html | Source code |
| navbar_html_heading | Source code |
| navbar_html_link | Source code |
| navbar_html_list | Source code |
| navbar_html_menu | Source code |
| navbar_html_search | Source code |
| navbar_html_separator | Source code |
| navbar_html_text | Source code |
| navbar_html_theme | Source code |
| navbar_link_components | Source code |
| navbar_links | Source code |
| navbar_links_haystack | Source code |
| navbar_news | Source code |
| navbar_structure | Source code |
| navbar_style | Source code |
| news_search_index | Source code |
| news_style | Source code |
| news_version | Source code |
| obj_type_friendly | Source code |
| obj_type_oo | Source code |
| on_ci | Source code |
| orcid_link | Source code |
| out_of_date | Source code |
| oxford_comma | Source code |
| package_mds | Source code |
| package_repo | Source code |
| package_topics | Source code |
| package_tutorials | Source code |
| parse_descriptions | Source code |
| parse_github_like_url | Source code |
| parse_integrity | Source code |
| parse_items | Source code |
| parse_opts | Source code |
| parse_section | Source code |
| parse_usage | Source code |
| path_abs | Source code |
| path_favicons | Source code |
| path_first_existing | Source code |
| path_index | Source code |
| path_package_pkgdown | Source code |
| path_pkgdown | Source code |
| pkg_authors | Source code |
| pkg_navbar | Source code |
| pkg_navbar_vignettes | Source code |
| pkg_timeline | Source code |
| pkgdown | Man page |
| pkgdown-package | Man page |
| pkgdown_config_path | Source code |
| pkgdown_print | Man page Source code |
| pkgdown_print.default | Source code |
| pkgdown_print.gt_tbl | Source code |
| pkgdown_print.htmlwidget | Source code |
| pkgdown_sitrep | Man page Source code |
| pre | Source code |
| preview_page | Man page Source code |
| preview_site | Man page Source code |
| print.Rd | Source code |
| print.pkgdown_xml | Source code |
| print.print_yaml | Source code |
| print.tag | Source code |
| print_yaml | Source code |
| process_conditional_examples | Source code |
| quarto_format | Source code |
| quarto_render | Source code |
| rd2ex | Source code |
| rd2html | Man page Source code |
| rd_file | Source code |
| rd_text | Source code |
| re_match | Source code |
| read_citation | Source code |
| read_desc | Source code |
| read_file | Source code |
| read_lines | Source code |
| read_meta | Source code |
| read_template_html | Source code |
| reference_redirects | Source code |
| release_bullets | Source code |
| remove_orcid | Source code |
| remove_useless_parts | Source code |
| render_md | Source code |
| render_navbar_links | Source code |
| render_page | Man page Source code |
| render_page_html | Source code |
| render_template | Source code |
| repo_auto_link | Source code |
| repo_home | Source code |
| repo_meta | Source code |
| repo_meta_gh_like | Source code |
| repo_source | Source code |
| repo_type | Source code |
| req_pkgdown_cache | Source code |
| rmarkdown_render_with_seed | Source code |
| rmarkdown_setup_custom | Source code |
| rmarkdown_setup_pkgdown | Source code |
| rmarkdown_template | Source code |
| role_lookup | Source code |
| rstudio_save_all | Source code |
| ruler | Source code |
| run_examples | Source code |
| same_contents | Source code |
| section_id | Source code |
| section_init | Source code |
| select_topics | Source code |
| set_class | Source code |
| set_classes | Source code |
| short_name | Source code |
| sidebar_section | Source code |
| site_meta | Source code |
| sourceCode | Source code |
| split_at_linebreaks | Source code |
| stop_bad_tag | Source code |
| stop_input_type | Source code |
| str_squish | Source code |
| str_trim | Source code |
| strip_html_tags | Source code |
| strip_stop_words | Source code |
| system_file | Source code |
| tablist_content | Source code |
| tablist_item | Source code |
| tablist_title | Source code |
| tag | Source code |
| tag_wrapper | Source code |
| template_articles | Man page Source code |
| template_candidates | Source code |
| template_navbar | Man page Source code |
| template_reference | Man page Source code |
| templates_dir | Source code |
| test-crayon | Man page |
| test-dont | Man page |
| test-figures | Man page |
| test-index | Man page |
| test-links | Man page |
| test-lists | Man page |
| test-long-lines | Man page |
| test-output-styles | Man page |
| test-params | Man page |
| test-sexpr-title | Man page |
| test-tables | Man page |
| test-verbatim | Man page |
| tex_paths | Source code |
| timestamp | Source code |
| topic_funs | Source code |
| tr_ | Source code |
| trim_ws_nodes | Source code |
| tutorial_info | Source code |
| tweak_anchors | Source code |
| tweak_class_prepend | Source code |
| tweak_extra_logo | Source code |
| tweak_footnotes | Source code |
| tweak_highlight_other | Source code |
| tweak_highlight_r | Source code |
| tweak_homepage_html | Source code |
| tweak_img_src | Source code |
| tweak_link_R6 | Source code |
| tweak_link_absolute | Source code |
| tweak_link_external | Source code |
| tweak_link_md | Source code |
| tweak_news_anchor | Source code |
| tweak_news_heading | Source code |
| tweak_page | Source code |
| tweak_quarto_html | Source code |
| tweak_reference_highlighting | Source code |
| tweak_rmarkdown_html | Source code |
| tweak_section_levels | Source code |
| tweak_sidebar_html | Source code |
| tweak_strip | Source code |
| tweak_tables | Source code |
| tweak_tabset | Source code |
| tweak_tabsets | Source code |
| tweak_useless_toc | Source code |
| unwrap_purrr_error | Source code |
| up_path | Source code |
| update_html | Source code |
| usage2text | Source code |
| usage_code | Source code |
| usage_code.COMMENT | Source code |
| usage_code.NULL | Source code |
| usage_code.RCODE | Source code |
| usage_code.Rd | Source code |
| usage_code.TEXT | Source code |
| usage_code.VERB | Source code |
| usage_code.tag | Source code |
| usage_code.tag_S3method | Source code |
| usage_code.tag_S4method | Source code |
| usage_code.tag_dots | Source code |
| usage_code.tag_ldots | Source code |
| usage_code.tag_special | Source code |
| usage_code.tag_usage | Source code |
| usage_type | Source code |
| uses_lightswitch | Source code |
| valid_filename | Source code |
| value2html | Source code |
| vec_type_friendly | Source code |
| version_page | Source code |
| version_tooltip | Source code |
| with_device | Source code |
| wrap_rmarkdown_error | Source code |
| write_if_different | Source code |
| write_lines | Source code |
| write_yaml | Source code |
| writing_file | Source code |
| xml2str | Source code |
| xml_replace_contents | Source code |
| xml_text1 | Source code |
| xpath_attr | Source code |
| xpath_contents | Source code |
| xpath_length | Source code |
| xpath_text | Source code |
| xpath_xml | Source code |
