Comments (8)
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.
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.
👍
from repo.js.
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.
@thomasklemm that is good info, but I would still like the option to embed individual files other than the README
from repo.js.
@svnpenn Gist-It might be what you are looking for until Repo.js offers this feature.
from repo.js.
@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.
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)
- Line-specific links don't work HOT 1
- Last files doesn't appear. HOT 3
- How do we actually use this? HOT 4
- Fallback for offline or not able to make API request
- Add caching so that Repo.js doesn't hit the Github API rate limit HOT 1
- Uncaught SyntaxError: Unexpected identifier in repo.min.js
- Bottom of the Repo cut off when opening first file in Chrome with clear cache HOT 2
- Define and register Bower package HOT 1
- Issue With Dots In Repository Name HOT 1
- Some Files Missing, Icons Missing
- When clicking on a file, it opens twice.
- Directories and Repositories with Whitespaces and/or Symbols cannot be Accessed HOT 2
- haha
- Link Broken
- How do I style it? HOT 1
- XSS vulnerability via filenames in repository
- Anyway to make this work with a Self Served GitLab Repository?
- https support
- Type Error: Cannot read property 'length' of undefined HOT 2
- Open .pfd files
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from repo.js.