rpkgkit/_pkgdown.yml at main · WangLabCSU/rpkgkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
url: https://wanglabcsu.github.io/rpkgkit/
template:
  bootstrap: 5
  light-switch: true
  bslib:
    bootswatch: sandstone
    code_font: { google: "JetBrains Mono" }
    pkgdown-nav-height: 100px
    bg: white
    fg: black
    primary: "#2c5f9b"

title: rpkgkit
description: >-
  Utilities for R package development including NEWS.md
    management, standalone file creation, and code formatting. Supports popular
    development workflows and integrates with 'usethis' and 'RStudio'. Includes
    helper functions for renaming functions and detecting common coding errors.

navbar:
  structure:
    left:
      - intro
      - reference
      - articles
      - tutorials
      - news
    right:
      - search
      - github
      - lightswitch
  components:
    reference:
      text: Reference
      href: reference/index.html
    search:
      search: []
    news:
      text: Changelog
      href: news/index.html
    github:
      icon: fab fa-github fa-lg
      href: https://github.com/WangLabCSU/rpkgkit/
      aria-label: GitHub

articles:
  - title: Vignettes
    contents:
      - code_convertion
      - news
      - pkg_maintain
      - readme_and_doc
      - standalone_tools

reference:
  - title: Functions
    desc: |
      The following functions help you to create and maintain an R package.
    contents:
      - add_changelog_in_standalone
      - add_double_colons
      - add_global_gitgnore
      - add_global_rbuildignore
      - air_format
      - badge_translated_by_ai
      - browse_standalone
      - check_pkgdown_reference
      - convert_func_syntax
      - create_standalone
      - is_dev_context
      - package_lost_glue_brace
      - package_print_and_cat
      - flir_fix
      - inquire_standalone
      - package_func_arg_explicit
      - package_func_call_explicit
      - news_md
      - rename_func
      - render_rmd
      - update_time_in_standalone
      - use_bugreports
      - use_hexsticker
      - use_multilanguage_readme
      - use_r_v4.1.0
      - use_url
      - use_vendor
      - use_workflow_test_branch
      - use_workflow_version_update
      - use_zzz
      - current_packages
      - detect_lost_glue_brace
      - detect_print_and_cat
      - imported_functions
      - make_func_arg_explicit
      - make_func_call_explicit
      - news_md_add_entry
      - news_md_check
      - news_md_show
      - convert_nonascii_code
      - open_cffinit
      - convert_knitr_chunk_header
      - convert_int_literals
      - package_convert_int_literals
      - badge_to_readme
      - GLOBAL_RBUILDIGNORE_PATTERN
      - PERMISSIVE_LICENSE