Stack Overflow
Stack Overflow

Questions tagged [readme]

A readme file is a file that contains information about something that should be read, generally before use.

A readme file is a file that contains information about something that should be read, generally before said thing should be used. These files can appear in many different formatting, including (readme.md), and plain text (readme.txt or sometimes just readme with no extension).

349 questions
11
votes
1 answer

Specify alternate project-level README.md on GitHub

Using GitHub's web-based interface I cannot figure out how to specify an alternate path / filename for the project's README file. When creating a new README, the web interface does give me the option of using any arbitrary path or filename I want,…
Μάκης Παλάσης
  • 138
  • 1
  • 9
10
votes
1 answer

Insert inline images in README.md

Is it possible to insert an inline image (base64 encoded) via HTML or Markdown in README.md (GitHub)? For example, this doesn't work:
Ivan
  • 101
  • 1
  • 4
10
votes
1 answer

GitHub relative internal repository links in PULL_REQUEST_TEMPLATE.md

Using a relative link as directed (https://help.github.com/articles/about-readmes/#relative-links-and-image-paths-in-readme-files) in a PULL_REQUEST_TEMPLATE.md does not relatively link correctly. When viewed in an actual…
Clif
  • 101
  • 7
10
votes
1 answer

Relative link in readme broken if readme viewed automatically by repo

I have a repo as part of a organization on github. For instance: MYORGANIZATION/MyRepository The repo contains a README.md file. Within this README.md file I have a link so another .md file which is located in the same repo ind the same folder as…
Alex
  • 365
  • 1
  • 2
  • 9
10
votes
2 answers

What does the README.md file in git repo do?

We have been using git repositories for projects. Also we download some code from there(Say sample code). I found ReadMe.md file on each repository. Why is it there? AND what is meaning of .md? Also each folder contain that file some time. Why…
Pankaj Badukale
  • 1,991
  • 2
  • 18
  • 32
10
votes
1 answer

Github README Render Gliffy diagrams

Is there a way to add a gliffy diagram in the README of a github repo? I know how to add an image and I have tried that approach with gliffy diagram but it does not work; the gliffy does not render. Perhaps the correct question is, is there a gliffy…
Kesh
  • 1,077
  • 2
  • 11
  • 20
9
votes
1 answer

Make GitHub's README look different on smartphones and desktops using only HTML (CSS is restricted)

I have a GitHub project with README.md file. I embed an image in the following way Here is an example of such an image. Note: GitHub allows using embedded HTML but not CSS, that's why I am using…
Sasha Shpota
  • 9,436
  • 14
  • 75
  • 148
9
votes
3 answers

How to link to heading containing dot (.) or comma (,) in markdown file (Table of contents)?

In my Readme.MD markdown file I want to create Table of Contents (for Github). [TOC] (generated by Typora) doesn't show on Github. It shows like [TOC]. Some of my headings contain characters like a dot or a comma. Is there any way to link to these…
LowLevel
  • 1,085
  • 1
  • 13
  • 34
9
votes
1 answer

How to use npm Marked with HighlightJS

How do you use npm Marked with HighlightJS? I'm trying to automate my docs to be parsed and styled. Looking at the following example from marked docs: // Using async version of marked marked(markdownString, function (err, content) { if (err) throw…
jtlindsey
  • 4,346
  • 4
  • 45
  • 73
9
votes
1 answer

Is there a way to add a link to the current repo in Github README.md?

Most of my repos' README.md files include instructions on how to clone/build/run/test the code: $ git clone https://github.com/TravelingTechGuy/app-store-validator.git $ cd app-store-validator $ npm i $ npm run build #lint and build $ npm run…
Traveling Tech Guy
  • 27,194
  • 23
  • 111
  • 159
8
votes
3 answers

GitHub reademe Error: Please add an env variable called PAT_1 with your github token in vercel

I used this in my GitHub readme. But it says now, "Something went wrong! file an…
vinhtranchau
  • 565
  • 2
  • 13
8
votes
3 answers

How to use smaller font size in a GitHub table?

How to use a smaller font size in a GitHub readme.md? I am trying to figure out how to use smaller text in the GitHub readme. More specifically, I created a table and I want the font size to be smaller for this table. I saw somewhere people…
Exploring
  • 2,493
  • 11
  • 56
  • 97
8
votes
3 answers

Github tool to validate links in markdown

What I plan to do in some of my README.md files is provide hyperlinks to other sites that I cite. However, we all run into that problem when links die or get moved, and said link becomes invalidated. =( Is there a github tool that can run nightly…
hlin117
  • 20,764
  • 31
  • 72
  • 93
7
votes
3 answers

Show languages with GitHub README.md stats

I'm trying to show used languages with GitHub README.md stats: ![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=myusername&theme=tokyonight) but private and public repositories are mostly C#, which is not shown:
user11137294
7
votes
2 answers

How do you create a link to a specified section of your readme.md file?

I am practicing readme files and I had a question about linking. Is there a way to link to a specific section of a readme? For example, I want to create a table of contents with links to the specific sections of my readme.md file. # Title ## Sub…
Mark Pinho
  • 105
  • 1
  • 6
1 2
3
…
23 24