Git Product home page Git Product logo

Comments (5)

mitchellmanware avatar mitchellmanware commented on August 27, 2024 1

@sigmafelix Ahh, yes I see.

r has been added to code blocks with code but not output (2967113).

from amadeus.

sigmafelix avatar sigmafelix commented on August 27, 2024

I found all code blocks in README.md were generic (i.e. starting with "```" not "```r"). It might be related to the problem. I will check it somewhere else and make a PR to Mitchell's branch with my changes that were pushed after the last PR.

from amadeus.

mitchellmanware avatar mitchellmanware commented on August 27, 2024

I think this happened as a result of not wanting to run the download chunks in the building of the package which runs the README.md file. I can fix these

from amadeus.

mitchellmanware avatar mitchellmanware commented on August 27, 2024

I think the lack of copy-paste functionality in the README page is default functionality. This thread discusses the copy-paste button in the function reference pages (which is enabled in our webpage), but no discussion of README.

I updated the README to separate code chunks from return messages, which now enables the copy-paste button in the source code readme without running the code.

Is this sufficient, or do we want to actually run the code blocks? @sigmafelix @kyle-messier

Screenshot 2024-07-10 at 7 41 11 AM

from amadeus.

sigmafelix avatar sigmafelix commented on August 27, 2024

I think the issue is in the pkgdown page. The current amadeus webpage displays code blocks without copy-and-paste functionality: https://niehs.github.io/amadeus

image

In contrast, all code blocks in beethoven webpage have the functionality (to note, copy buttons show up upon hovering the cursor on a code block): (https://niehs.github.io/beethoven) The difference between README.md source of amadeus and that of beethoven is that the backtick symbols are followed by "r" or nothing.

image

https://github.com/NIEHS/beethoven/blob/9e4daf19e69c2a099f5b9471da96ce2a3c5cd942/README.md?plain=1#L9-L20

My quick experiment in one of my repos shows this. https://sigmafelix.github.io/speed/

from amadeus.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.