Comments (1)
In GitHub, if a Git repository has a README file in its main (top-level) directory, the README file is automatically converted into formatted HTML and presented on the main web page of the git repository, underneath the list of files and directories in the repository. Various different file extensions can be used, but there should not be more than one file named "README" at the top-level of a GitHub repository. The conversion to HTML takes account of the file extension of the file – for example, naming the README file for a GitHub repository "README.md" would cause GitHub to treat it as a GitHub-flavored Markdown file, which is also the default README file format on GitHub.
This makes using GitHub a low-effort way to create a web page for a git repository (GitHub also supports the publication of wikis and separate websites, which may be formatted however the developers want).
Because the GitHub web interface lets users edit a file in a relatively streamlined way, without manually cloning the repository and manually making a pull request, it supports wiki-style editing of the README file with approval necessary by a committer (i.e. someone who has write access to the repository) if the user is not a commit themselves.
However, within the GitHub app for Android mobile devices, the contents of README files are not shown underneath the list of files and nor are README files formatted as HTML when viewed.
from wysihat-engine-demo.
Related Issues (2)
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 wysihat-engine-demo.