A simple GitHub README viewer that turns any public repository into a clean webpage.
- Render GitHub README files using GitHub's official API
- Supports any public GitHub repository
- Responsive layout for desktop and mobile
Open the homepage and enter either:
https://github.com/owner/repository
or
owner/repository
The repository will be available at:
https://repo-site.github.io/owner/repository
.
├── assets/
│ └── favicon.svg
├── css/
│ └── style.css
├── js/
│ ├── app.js
│ ├── constants.js
│ ├── state.js
│ ├── router.js
│ ├── services/
│ │ └── github.js
│ ├── ui/
│ │ └── renderer.js
│ └── utils/
│ └── repository.js
├── 404.html
├── index.html
└── README.md
Use a static server that supports SPA routing.
For example:
serve -s .This project is licensed under the MIT License.