Adding README pointer in Github - github

So im trying to do something similiar to what vercel does with their README.
When I go into the raw code its just the path to the referenced readme
packages/next/README.md
So I attempted to do this with my own repo and was given back
packages/repo name here/README.md
at the front of my github page.
Anyone know how to do what vercel does?

That symbol means that the readme directory is actually a submodules: a pointer to another git repository. You can't click on the link in github because it point at a repository that is not hosted on github.
the another documentation you can see reference in here about blog sobmodules

Related

Why doesn't my own GitHub page show my project?

This is my first GitHub page; I have created repository and even pasted my project into it, but when I enter the URL it gives me 404 error with "There isn't a GitHub Pages site here" description.
My project called 'weather-app' and the URL: https://salehghari.github.io/
So it should be like this: https://salehghari.github.io/weather-app/weatherapp.html
I checked your repository on Github and all the Builds under Actions are marked as Failure with the following error under Deploy:
Error: No uploaded artifact was found!
Under Build I see this:
Error: fatal: No url found for submodule path 'weather-app' in
.gitmodules Error: The process '/usr/bin/git' failed with exit code
128
You are using a submodule but I don't see a clickable link on the repository, are you sure that is correct ? Check if this submodule is correct, there is also an issue on Github Community about this topic.
You need to configure the branch you want to use for your GitHub pages site.
These are the steps you need to follow
I deleted that repo and created another. that un-clickable folder in previous repo was caused the 404 error. Because I had pushed that folder on GitHub once so it means It had had a .git file in it. Thank you every one I appreciate your helps

Automatically update GitHub wiki based on repository markdown files

I'm fairly new to GitHub and I've been trying to get the GitHub Wiki associated with a project to get the content from the main repository with no success.
Online there are guides on how to do this on Microsoft Azure here, but for some reason, I cannot find anything similar for GitHub. I am not sure where to ask this question so I came to the trusted StackOverflow community.
Basically I have a repository where we are uploading a series of markdown documents (see giovannellilab/protocols) and I would like the content of the wiki for the same project to be updated with pages coming from the repository. Each markdown file in the repository becomes its own wiki page. Ideally, the wiki will get automatically updated every time we push something new to the repo or we merge a new pull request.
So far I have not found an easy to implement a solution.
I've also tried to use a GitHub Action found in the marketplace, SwiftDocOrg with no success. I'm new to GitHub-actions and even follwing the guide I could not make this work.
Here the content of my .yml page:
- name: Publish to GitHub Wiki
uses: SwiftDocOrg/github-wiki-publish-action#1.0.0
with:
# A path to the directory of files to publish
path: giovannellilab/protocols
The action is failing each time (obviously something is wrong/missing, but I cannot figure out what).
Any suggestions on how to make it work in GitHub?
Any other place where I can host documentation pulling directly from a GitHub repository?
Any other better way to implement this?
Thank you very much,
Don

GitHub repo link not showing in marketplace

I published 2 extensions to the VS marketplace, in the manifest file and on the marketplace I added the source code github link. When I go to the marketplace, there is no link to the repository or showing open issues/pull requests.
Is there anything I forget?
Assuming the extensions are for vs. It's fairly easy to publish it to marketplace as we all know.
Please remove the github links in manifest file,and check the github url again:
I think maybe there has something wrong with your link here. I've done several tests and find the Project Details Section would disappear only when the github link was not valid for a github repo.(Even the github repo is private, the link to repo will display.)

Github Wiki as a subfolder of the main project

We have a project self-hosted on our Phabricator instance. I made a mirror of the project on GitHub.
The project has a subfolder called docs that contains the documentation in Markdown.
If the project was hosted on Github, I would add the wiki as a submodule of the main project -- however, the project is hosted on Phabricator and I do not want anything on the Phabricator repo to link to GitHub.
How can I tell Github to use the docs/ folder for the wiki, without any modification needed to the Phabricator repo?
This link from GitHub's documentation would indicate that GitHub wiki's are stored in a separate repository which I would think means this is not possible.

How to add a relative link to a file in a submodule in github markdown?

I'm using markdown for the README file in my repositories.
Relative links work well for files in the same repo.
But I want to link a file in a submodule (so that the same version as the submodule is displayed).
The usecase is the following: I have a submodule in external/fancy-lib. In the README.md of my repository I want to add "please refer to fancy-lib's [README](external/fancy-lib/README.md) for info about the required packages", but it generates a non-existent link.
Adding a link to fancy-lib's README from fancy-lib's repository would point to HEAD which is not always the same version included in my repository.
On the other hand, manually updating the link each time the submodule is updated to a new version (git pull) is a burden of maintenance.
Any workaround?
I do not think relative links are going to work. One can always use the full URL though, which is something like
![](https://raw.githubusercontent.com/<account>/<name of submodule repo>/README.md)
or
https://github.com/<account>/<repo>/blob/<hash>/README.md