Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first pass at editing master help page file #3

Closed
papsti opened this issue Feb 21, 2018 · 4 comments
Closed

first pass at editing master help page file #3

papsti opened this issue Feb 21, 2018 · 4 comments
Assignees

Comments

@papsti
Copy link
Collaborator

papsti commented Feb 21, 2018

No description provided.

@papsti papsti self-assigned this Feb 21, 2018
@papsti
Copy link
Collaborator Author

papsti commented Feb 27, 2018

I wonder if there is a way to hyperlink to headers within the Markdown document... that would make for a more readable document (e.g. where the tab names are enumerated under ##Interface, it would be nice if each tab name were linked to the help section dealing with that tab).

@papsti
Copy link
Collaborator Author

papsti commented Feb 27, 2018

re: last comment, there is absolutely a way to do this if I can include my own HTML head text confined to the help subpage, but I haven't figure out how yet (see #6).

@papsti
Copy link
Collaborator Author

papsti commented Mar 7, 2018

@felixthoemmes, you can now compile the help/help_page.Rmd file into www/help_page.html after you work on the manual. This output file gets read by the shiny app automatically.

Note that if you simply try to "knit" help_page.Rmd in RStudio using the available button, help_page.html doesn't get created in the correct directory for shiny to find it (i.e the www directory).

@papsti
Copy link
Collaborator Author

papsti commented Mar 7, 2018

Note that you can create hyperlinks in the document by setting anchors on headers like ## Header 1 {#h1anchortag} and then referencing them with [display text]{#h1anchortag}. For an example, search for #model in help_page.Rmd.

felixthoemmes pushed a commit that referenced this issue Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant