Document previously undocumented features - #132
Open
yihui wants to merge 1 commit into
Open
Conversation
Complete documentation for features that existed in the source code but were missing from the book chapters under docs/: - 02-fuse: add a "Helper functions" section covering get_context(), fuse_env(), fuse_exit(), raw_text(), and timing_data(); document the exec engine's `ext` chunk option. - 04-mark: document the cross_refs option, the plain-title and generator HTML meta variables, and the full set of format fields (template, keep_md, keep_tex, latex_engine, citation_package). - 08-site: document the top-level `type` field, the book `time` field, the numeric `rebuild` value, and a new "Default assets and layout" section (auto nav menu, copyright footer, default css/js, css2/js2, absolute-path rewriting). - 07-editor: document the new-file wizard (feature checkboxes, filename datalist, auto .Rmd extension, seeded YAML) and rendering a whole project. - examples: add 027-raw-text to demonstrate raw_text(). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Read the full package source (
R/*.R) and cross-checked it against the book chapters underdocs/. This PR fills the gaps — features that existed in code but had no documentation in the book.Changes
docs/02-fuse.Rmd— new "Helper functions" section forget_context(),fuse_env(),fuse_exit(),raw_text(),timing_data();execengineextchunk option.docs/04-mark.Rmd—cross_refsoption;plain-titleandgeneratorHTML meta variables; full YAML format fields (template,keep_md,keep_tex,latex_engine,citation_package).docs/08-site.Rmd— top-leveltypefield; booktimefield; numericrebuildvalue; new "Default assets and layout" section (auto nav menu, copyright footer, default css/js,css2/js2, absolute-path rewriting).docs/07-editor.Rmd— new-file wizard (feature checkboxes, filename datalist, auto.Rmd, seeded YAML) and rendering a whole project.examples/027-raw-text.{Rmd,md}— new rendered example demonstratingraw_text(), wired into the docs via.ex(27).Verification
fuse_book()builds to HTML with no new errors; example 027 renders correctly; the additions introduce zero new unresolved cross-references.🤖 Generated with Claude Code