diff --git a/README.md b/README.md index 470b257..3c357de 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ > Because GitHub's `README` styling is actually really nice -## Background +## Framework [![](https://img.shields.io/badge/author-@KrauseFx-blue.svg?style=flat)](https://twitter.com/KrauseFx) @@ -10,7 +10,7 @@ If you have a little side project, often you might want a simple landing page. T Using your GitHub `README` as the main landing point works great for open source projects, where your visitors are developers and are familiar with GitHub, as well as you have all the text right where the code, the Issues and PRs are. But for some projects this isn't ideal. I built this project within a few hours for myself to get [WalkWithFriends](https://walkwithfriends.net/) off the ground fast, without investing in building an actual website, or using a bloated website builder. -Some issues you run into when using GitHub as your main landing page +Some issues that you run into while using the GitHub as your main landing page - Maybe your project isn't actually an open source project, so you can't just host a `README` on GitHub - If you want to link to just the `README`, you could append `#readme` to your browser URL (making the URL less pretty), or the visitor has to know they have to scroll down @@ -27,13 +27,13 @@ Some issues you run into when using GitHub as your main landing page A simple script that converts a markdown (`.md`) file to a single HTML file, that includes all the HTML and CSS code inline, so you can host it anywhere. -There is no need to use this script if you already convert your markdown file to HTML, you can directly use the [stylesheet](https://github.com/KrauseFx/markdown-to-html-github-style/blob/master/style.css) of this repo. +There is no need to use this script if you already converted your markdown file to HTML, you can directly use the [stylesheet](https://github.com/KrauseFx/markdown-to-html-github-style/blob/master/style.css) of this repo. ## How it works This project doesn't actually use the GitHub stylesheet, it's far too complex, and has legal implications. -Instead this project does 2 things: +Instead, this project does cover 2 things: - Convert the Markdown to HTML using [showdown](https://github.com/showdownjs/showdown), the most popular JS markdown parser. This could be replaced by the [official GitHub markdown to HTML API](https://github.com/KrauseFx/markdown-to-html-github-style/issues/2) - Inject the GitHub-like CSS code at the bottom of the page @@ -63,7 +63,7 @@ This will read the `README.md` from your current working directory and output th Check out the [open issues](https://github.com/KrauseFx/markdown-to-html-github-style/issues), in particular code blocks currently don't support syntax highlighting, however that's something that's rather easy to add. For a minimalistic stylesheet we could take the styles from [krausefx.com css](https://github.com/KrauseFx/krausefx.com/blob/021186e228e183904af68ad8fc500c35107f00ae/assets/main.scss#L345-L438). -## Playground to test +## recreation ground for test ``` {