I am trying to create a readme on github like the following https://github.com/fleejy/ckme136-capstone
I guess my question is how did this content creator create the links under the Documentation And Repository Organization heading in the Readme.md file as I would like to emulate this.
I did some searching for relative references examples but was not able to figure it out.
Any advice would be very much appreciated.
Thanks
It's very Simple, you have to make a URL in markdown referring to your folder/file.
For making a URL in markdown files you use a syntax like this [Text](exampleURL) here your Text is the text which will appear in the markdown file and the exampleURL is the URL you want to go to.
A Working Example Will Be Like this [Google](https://google.com).
If you want to refer to a particular file/folder inside your repository you don't need https:// all you need is to provide the path of the folder/file
for example in my repository i have a file named example.pdf inside a folder named PDFs so my markdown code will look like this [Example PDF](PDFs/example.pdf)
Markdown is pretty easy and you can learn markdown syntax with this CheatSheet.
Question
I am wondering if there is a way to get the content of a file on a github repo with specified line number(s) through GitHub APIs. I know that it is possible to generate a permanent link to a code snippet from the github UI as follows
https://github.com/<org_name>/<repo_name>/blob/master/<path_to_file>#L{Start}-L{End}
However I cant seem to find a way to get the content of a file on a specific line number(s) through their Github APIs. I tried the Search API but couldnt find anything useful. Any help on that is greatly appreciated!
Use Case
I am creating a tutorials application and I would like to query lines of code to generate dynamic code snippets from a file hosted on github.
This gist is showing a message File suppressed. Click to show. on one of the files. Why is this file suppressed?
The file contains a bookmarklet, starting with javascript:, perhaps that is not safe?
I have one that is not dangerous, only a variable declaration, but it is very long. Perhaps that is the reason? (length).
Me too. When I created a bookmarklet I was surprised too for that message, so I googled and came here.
Initially I had a js code in one line and a comment with a word "bookmark", but I tried and pasted the full code and later the one line bookmarlet specifying it. Also to reassure I pasted the bookmarklet in a comment too
Here you can see: Gist
Github helpfully renders Markdown (.md) files to HTML when viewing on github.com (for example, this README.md).
When viewing any other source file, it is shown as unrendered source code (for example, this .gitignore). A handy feature this gives is linking directly to a line in the source by clicking the line number (for example, like this).
How can I view the unrendered source of Markdown files on Github (so I can link to a particular line in the source)?
note: I know of the "Raw" button, however it does not provide any of the nice UI Github has.
If you don't want to use the "raw" button, you can (since June 2021) add ?plain=1 to your GitHub markdown file URL:
Appending ?plain=1 to the url for any Markdown file will now display the file without rendering.
As with other code files, it will also show line numbers, and can be used to link other users to a specific line or lines.
For example, appending ?plain=1#L52 will highlight line 52 of a plain text Markdown file.
Example:
https://github.com/git/git/blob/master/README.md?plain=1#L49-L51
Since Sept. 2021, there is a button which adds the ?plain=1 for you:
Use the "Raw" button. For instance, if you were looking at README.md there is a Raw button in the Navigation. This can be simple URL change (from blob to raw), but in this case becomes a separate link.
Edit: There is no "pretty" view for the Markdown source. There's the converted HTML view, the Raw view without the UI, and the Blame view. Only the Blame view provides you with the ability to link to a specific line within the source.
Edit 2: The other option is to use Anchors within the README.md. If you take the Installation title for example, you can directly link within the content of the Markdown file. Assuming you don't have anything hidden within the Markdown itself, this is closer still to solving your original question.
Using the "Blame" button, you are able to see the source of the Markdown (for example, like this).
Unfortunately, "Blame" comes with extra UI elements which make the source more cluttered.
Refined Github provides an additional "Raw" button to view the raw source and link to a specific line:
I ran into this issue, as a complete surprise to me, on a file with a .wiki extension. It appears that files with .wiki, .mediawiki, and .wikitext extensions are recognized and rendered as HTML, with a table of contents even. I guess it makes sense, what with GitHub projects having wikis and all.
That's nifty, but this one particular case, I really wanted the raw wikitext to be visible and copy-pasteable, not some rendered representation of it.
The only half-way solution I found was to use a bogus file extension that isn't one of the ones recognized by GitHub, and then a .gitattributes to tell GitHub how to syntax highlight it, e.g.:
*.wiki_ linguist-language=mediawiki
I'm not thrilled about this, but all the good extensions were already "taken" according to the languages.yml linked above.
I have javascript source code served at http://www.example.com/static/script.js. I'm writing documentation and rather than including the code of certain functions I want to refer to, I'd just like to link to the source- but I would like to link to the specific line of the Function in the source document.
Is this possible, to create a link to a text document at a specific line without using html anchors or javascript window.scrollTo?
Never found a way to link to javascript source, but easy to do with GitHub - Just add "#L" + lineNo to the url. For instance: https://github.com/ArbolEric/RaphaGraph/blob/master/src.js#L210
Highlights and jumps to line.