361 questions
1
vote
0
answers
51
views
How to copy the README.md file, inside an angular project before publishing it to npm
I've created a library with Angular libraries
This is my pretty default project structure
- README.md
- package.json
- angular.json
- projects
- my-project
- ng-package.json
- package.json
...
0
votes
0
answers
41
views
How to exactly fit an image in a roundedImage for .SVG image?
I've been trying to make this work for quite some time and have no clue whatsoever. I'm trying to make an image having a little gradient border, and fit in a rounded box.
<svg viewBox="0 0 ...
2
votes
1
answer
35
views
How to add rest api images so we can add it in our GitHub to refer later
I created one project and at the end to test I took REST APIs screenshot. I want to know what's best way to keep all those images at one place.
Either in Readme or somewhere?
In folder or in Readme ...
1
vote
0
answers
31
views
How to write indexes in markdown
Does anyone know, can I write k, k+1, ... - letter as indexes, for example the same way like in the picture
k, k+1 - the indexes
I usually wrote just in the form of sk, sk+1... but in this example it ...
0
votes
1
answer
21
views
Image in README via cdn url does not show on NPM page
I have a publicly visible image. Url to the image is this:
https://cdn.jsdelivr.net/npm/uni-module-common/img/action1.png?raw=true
When I use this url in a README file in my NPM repository, the image ...
0
votes
0
answers
20
views
How to Insert Text with Background Images and a Gallery in GitHub README with a Three-Column Layout?
I'm working on my GitHub README and I want to insert an image gallery alongside text with a background image. My goal is to achieve a three-column layout that includes text with a background image and ...
0
votes
1
answer
108
views
How can I adjust the repository card's color to match the GitHub theme when switching between different themes?
This appears visually appealing in light mode but not in dark mode. I aim to ensure compatibility with both light and dark themes in my README.md file.
Dark Theme Image
Light Theme image
## 🍋🟩 ...
1
vote
1
answer
46
views
Markup file slug in .NET
I am using Markdig nuget package right now to read my markup files and convert them to HTML
string content = File.ReadAllText(mdFilepath);
string? result = Markdown.ToHtml(content, pipeline);
But ...
0
votes
0
answers
26
views
Scroll to github readme image when hyperlink is clicked
I have a github readme.md file, the beginning of which displays an image.
Later down the file I want to create a link that on clicking scrolls the page up to that image.
How do I achieve this ...
1
vote
1
answer
203
views
How can I make an anchor tag open link in new tab, in my Github repo's readme.md file
I tried using target attribute to open the anchor tag's link in new tab, but it doesn't work. How can I make the readme file open links in new tab?
<a href = "<link>" target="...
0
votes
0
answers
151
views
Modify a autogenerated README.md file using openapi
I am generating client code for my API using the following commands:
# generate openapi-schema yml file using bazel and spectacular
bazel run //projects/api:manage spectacular -- --fail-on-warn --file ...
0
votes
1
answer
149
views
Issue with rending table in Readme.md
I want to add a table in readme.md and I am using below code/lines but its not rendering properly
| Relational | Non-Relational |
|------------|----------------|
| Standardized | Non-...
0
votes
0
answers
163
views
GitHub README.md file is not displaying the video
In Github Readme, I would like to display a video. But it's showing the link only instead of video preview.
You can also find the file here.
Readme.md
Video 1 : Not working
https://github.com/...
1
vote
4
answers
164
views
Extract version-specific upgrade notice from readme text
I am currently writing a PHP function which should help me to extract an upgrade notice from a given readme text.
This is my source text:
Some stuff before this notice like a changelog with versioning ...
0
votes
1
answer
83
views
Why Github could be not showing my symliked README's images?
For convenience, I have had to move my README file (in this case README.htm) to my own directory and symlink it from .github folder as README.md in order it's recognized by Github. Well, even though I'...
0
votes
0
answers
13
views
Github Pages going live but not showing the html contents provided
I don't understand what the problem is after writing all my codes and confirming they work I pushed them and it was okay but when it went live it didn't show me the html file content it kept showing ...
1
vote
1
answer
1k
views
nested, indented lists with collapsable sections
How to create a markdown list with:
each item being collapsible or not
items are indented, sub-items are indented 2 times etc ...
each item "body" containing at each level having the ...
0
votes
0
answers
39
views
Import a Markdown inside a Markdown / README.md
I have a folder structure that looks like this on GitHub:
Project
|
+-- Readme.md
|
+-- Images
| |
| \-- example.png
| \-- general.png
+-- markdown
| \-- table.md
I can ...
0
votes
1
answer
214
views
License not specified even though there is a LICENSE.md in the README
I have added the LICENSE.md file in the repo but it is still showing up as not specified in the README.
When I click on license icon in the README, it redirects me to this Link. This is expected as I ...
2
votes
1
answer
551
views
Github contribution grid snake is showing wrong
I want to show this cute snake in my Github.
Referenced this site and wrote this in [MY_GITHUB_USERNAME]/.github/workflows/main.yml using base branch 'main'.
name: Generate Snake
on:
schedule:
...
0
votes
1
answer
259
views
Is there a way to align text to the left and to the right within the same line in a markdown file (specifically for use in a README file on GitHub)?
I have a linked table of contents in the README for a repository on GitHub, but would also like to have a "return to TOC" link at every title through the rest of the README as it's quite ...
0
votes
1
answer
306
views
What files are transformed into markdown tabs on Github and how to add custom files?
I've noticed that some files are turned into Markdown tabs in a GitHub repository, e.g.,
I wonder what files are turned into tabs, besides README.md and LICENSE, and how to add custom files to this ...
1
vote
1
answer
235
views
Unable to add a link inside the summary tag in GitHub flavored markdown
Considering the below markdown code, what I would like to do is target the <summary id="stage-one">Stage 1</summary> from inside the Stage 3 content as such [Link to Stage 1](#...
0
votes
1
answer
132
views
How can I update my README.md file in a cookiecutter project with python?
I am trying to automatically update my README.md file in my cookiecutter project after it has been created. The project structure in the README.md should be adapted according to the features selected ...
0
votes
1
answer
225
views
How to stop VS Code opening .md files in the browser
Every time I do open a markdown file in VS Code, it opens up in Chrome as well (in preview mode). When it does it also brings it to the top and it's annoying closing it each time. I don't want it to ...
0
votes
0
answers
38
views
Todoist in Github Readme
Please, I would like some help to put on Todoist in my Github readme.md.
I'm following the tutorial Todoist Readme but I have a problem with API key in this point:
Go to your repo secrets by hitting ...
0
votes
1
answer
508
views
A Specific Image in Our README Does Not Appear in BitBucket Why?
I have an Image hosted in our BitBucket repository and when I got to BitBucket to look at the code it does not render, though other images do. The README codeline that has the image is this:
<img ...
3
votes
0
answers
448
views
AzureDevops task to create document in azure wiki
In azuredevops server pipeline task, i have a task to create .csv file from the kubernetes get command output and which working as expected. Looking for a way to publish this .csv table format to ...
0
votes
0
answers
51
views
Publish Java to Github package registry with README.md [duplicate]
I'm publishing my java program to the GitHub package registry, but I can't attach the README.md so I don't have to go into the package and fill in the Description manually. Can you help how to solve ...
1
vote
0
answers
213
views
Trying to use readme.md file as main page file in Doxygen results in blank
I am trying to use .md file as main page file for Doxygen generated HTML documentation. I provide path to directory, where source code resides as well as path to readme file at the input tab. I also ...
1
vote
1
answer
256
views
Add image with link to Github flavored Markdown in README
How can I add a clickable image with link into GitHub README.md file?
For example a "Buy me a Donut" badge:
The image is an SVG file, so it should be also possible to set a specific width.
...
2
votes
1
answer
126
views
How to add links for ordered list in Readme md file
How to add a link for ordered list 'ol' items in Readme md file. I do not want to paste the link rather use something like this:
[GSMA](https://www.gsma.com/esim/esim-specification)
[TCA (...
0
votes
1
answer
783
views
Is there a way to automatically add timestamp of a file's last commit in Github README.md file?
Suppose a Github repo has multiple files. In README.md, I can name those files and provide a link to each file as follows:
[test1.py](path/to/test1.py)
[test2.py](path/to/test2.py)
I would like to ...
4
votes
1
answer
872
views
Where to place summary & UML diagrams in a GitHub repository?
The README.md files of many popular GitHub repositories usually provides a high-level overview of the application's purpose and its main features, with usage instructions (e.g. how to compile & ...
0
votes
1
answer
382
views
How to add png image to my ReadMe file on Github?
enter image description here The picture is not showing on my Readme file, only the link as shown in the photo. photo itself not showing, only the link
I tried using html syntax instead, tried ...
-3
votes
1
answer
999
views
How to update the profile readme automatically
I have a repository located at the following URL: https://github.com/MateiMartin/MateiMartin/tree/main.
Within this repository, there is a README file that I wish to update automatically every 30 ...
0
votes
0
answers
780
views
Embed an iframe in Bitbucket's README.md
I would like to embed an iframe in a Bitbucket README.md file. I know that it is possible to insert an iframe using markdown, but in Bitbucket it was not possible to render the iframe in the ...
1
vote
1
answer
4k
views
how to create directory structure in readme.md in VS Code
Is there any easiest way to create project directory structure in readme.md file in VS Code or CMD?
for example :
I have following project directory structure and want to put these folder structure to ...
1
vote
1
answer
306
views
How to add kaggle dataset download stats in github readme file?
I am trying to add a badge type indicator in the github readme to show how many dataset downloads from the kaggle have occured so far (much like showing page visit count, etc). Is there any way to add ...
1
vote
0
answers
564
views
Shields.io badges not displaying releases or logo for correct user and repo
I'm currently working on creating badges using Shields, and I have made sure to provide the correct user and repository names. Additionally, I have included the correct logo code obtained from ...
1
vote
0
answers
269
views
How to access the markdown files stored in the second repository in the Astro framework
How to access the markdown files stored in the second repository in the Astro framework.
I am working on a website that is built using the Astro framework. Below is the function glob which returns an ...
8
votes
3
answers
781
views
GitHub reademe Error: Please add an env variable called PAT_1 with your github token in vercel
I used this in my GitHub readme.
<img align="center" height="170" src="https://github-readme-stats.vercel.app/api/top-langs/?username=[GitHub UserName]&layout=compact&...
0
votes
2
answers
453
views
How to write percentage in readme.md file on github when using Latex syntax?
I'm trying to put a math expression in README.md file on github. So I followed the docs from github: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-...
2
votes
0
answers
333
views
Backslash is automatically added after saving on README.md
I am editing our README.md. I noticed that on save, it adds \ (backslash) on save.
[:heavy_check_mark: JUMP TO](jump-to-sample)
turns to this after saving:
[:heavy\_check\_mark: JUMP TO](jump-to-...
0
votes
1
answer
689
views
https markdown links don't work in README.md
I was trying to insert a markdown link in a README.md file (in particular, the README.md file of the special repository whose name is the same as my Github profile), on Github.
Although I've done this ...
17
votes
4
answers
90k
views
Github - how to change font size in markdown file?
I'm wondering how to change font size in Readme.md file.
`**Zad. 0** <br />`
I want 'Zad. 0' to be bigger, but i have not found any solution yet.
0
votes
1
answer
445
views
How to use special characters e.g. ¥, ‡ in the footer of a README.md file on GitHub to replace the default page numbering (1, 2, ...)?
Can I please seek you help on how to use special characters e.g. ¥, §, ‡ in the footer of a README.md file on GitHub to replace the default numbering (1, 2, ...)?
I tried the following, but it is ...
0
votes
0
answers
170
views
I am able to add a link to readme file but not able to add a link to other files in the repo
I have created links , but it appears as normal text after committing the change
I am expecting the link the be created when I commit the changes in the github file just like I am able to add the link ...
1
vote
0
answers
228
views
Is there a way to refer a single swagger schema in Readme.io docs?
In our public documentation, we've linked swagger endpoints to Readme documentation.
But is there a way to import and refer to a single Schema entity, for example, Address in this case (swagger):
For ...
2
votes
1
answer
990
views
In .md files, does HTML h1 and markdown # work the same?
I am learning how to make README.md files stylish and easy to read. I am also trying to learn good coding, GitHub, and repository structuring practices.
I found that I could style README.mds using ...