Giter Club home page Giter Club logo

Comments (8)

darcyclarke avatar darcyclarke commented on May 25, 2024

Hey Raphael,

Appreciate the feedback. I'm going to set this as a feature request and get to work on some kind of implementation for sure. Right now you can view single files once you click on them but I think it would be cool to just showcase an individual file by default as well. Let me know if that's what you were thinking.

from repo.js.

raphaelbastide avatar raphaelbastide commented on May 25, 2024

Nice, just for your information (and inspiration), here is a project of mine that needed to import a README, and some other files. That is why I am really interested by you project.

from repo.js.

 avatar commented on May 25, 2024

👍

from repo.js.

thomasklemm avatar thomasklemm commented on May 25, 2024

The Github API has an (I believe) fairly new call that will return any repo's Readme. (See Get a Readme (Github API).) If some specific headers are set in your request the API in HTML containing i.e. all the Syntax Highlighting that Github Flavoured Markdown offers.

@darcyclarke Great work on Repo.js. It would be great however if it would allow for embeding a Readme in rendered HTML instead of unrendered Markdown.

Background: I was looking for a way to embed a Readme in a project of mine, stumbled on Repo.js, and wrote a basic jQuery Plugin I extracted and called Readme.js.

Bye, Thomas

from repo.js.

 avatar commented on May 25, 2024

@thomasklemm that is good info, but I would still like the option to embed individual files other than the README

from repo.js.

thomasklemm avatar thomasklemm commented on May 25, 2024

@svnpenn Gist-It might be what you are looking for until Repo.js offers this feature.

from repo.js.

 avatar commented on May 25, 2024

@thomasklemm I have already created a ruby plugin that implements this functionality. I would prefer a Repo.js implementation over what I have written or some other Gist-it. Please stay on topic.

from repo.js.

thomasklemm avatar thomasklemm commented on May 25, 2024

Sure, just trying to help here with some related solutions I stumbled upon while searching for how to embed a Readme.
There's nothing as powerful as Repo.js out there, and I sure would favour an implementation of this feature as well.

from repo.js.

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.