Skip to content

Commit

Permalink
Merge pull request #2220 from h5bp/markdown-cleanup
Browse files Browse the repository at this point in the history
updating some markdown formatting
  • Loading branch information
roblarsen authored Apr 17, 2020
2 parents af86a90 + e006c01 commit 805d619
Show file tree
Hide file tree
Showing 17 changed files with 575 additions and 509 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Choose one of the following options:
* A custom build of [`Modernizr`](https://modernizr.com/) for feature
detection
* [`Apache Server Configs`](https://github.com/h5bp/server-configs-apache)
that, among other, improve the web site's performance and security
that improve the web site's performance and security
* Placeholder CSS Media Queries.
* Useful CSS helper classes.
* Default print styles, performance optimized.
Expand Down
28 changes: 15 additions & 13 deletions dist/doc/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,21 +14,23 @@

## Development

* [Extending and customizing HTML5 Boilerplate](extend.md) — Going further
with the boilerplate.
* [Extending and customizing HTML5 Boilerplate](extend.md) — Going further with
the boilerplate.

## Related projects

The [H5BP organization](https://github.com/h5bp) maintains several projects
that complement HTML5 Boilerplate, projects that can help you improve different
The [H5BP organization](https://github.com/h5bp) maintains several projects that
complement HTML5 Boilerplate, projects that can help you improve different
aspects of your website/web app (e.g.: the performance, security, etc.).

* [Server Configs](https://github.com/h5bp/server-configs) — Fast and
smart configurations for web servers such as Apache and Nginx.
* [Apache](https://github.com/h5bp/server-configs-apache)
* [Google App Engine (GAE)](https://github.com/h5bp/server-configs-gae)
* [Internet Information Services (IIS)](https://github.com/h5bp/server-configs-iis)
* [lighttpd](https://github.com/h5bp/server-configs-lighttpd)
* [Nginx](https://github.com/h5bp/server-configs-nginx)
* [Node.js](https://github.com/h5bp/server-configs-node)
* [Front-end Developer Interview Questions](https://github.com/h5bp/Front-end-Developer-Interview-Questions)
* [Server Configs](https://github.com/h5bp/server-configs) — Fast and smart
configurations for web servers such as Apache and Nginx.
* [Apache](https://github.com/h5bp/server-configs-apache)
* [Google App Engine (GAE)](https://github.com/h5bp/server-configs-gae)
* [Internet Information Services
(IIS)](https://github.com/h5bp/server-configs-iis)
* [lighttpd](https://github.com/h5bp/server-configs-lighttpd)
* [Nginx](https://github.com/h5bp/server-configs-nginx)
* [Node.js](https://github.com/h5bp/server-configs-node)
* [Front-end Developer Interview
Questions](https://github.com/h5bp/Front-end-Developer-Interview-Questions)
19 changes: 11 additions & 8 deletions dist/doc/css.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ HTML5 Boilerplate's CSS includes:
* [Normalize.css](#normalizecss)
* [main.css](#maincss)

This starting CSS does not rely on the presence of
[conditional class names](https://www.paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/),
This starting CSS does not rely on the presence of [conditional class
names](https://www.paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/),
or [Modernizr](https://modernizr.com/), and it is ready to use no matter what
your development preferences happen to be.


## Normalize.css

In order to make browsers render all elements more consistently and in line
with modern standards, we include Normalize.css — a modern, HTML5-ready
alternative to CSS resets.
In order to make browsers render all elements more consistently and in line with
modern standards, we include Normalize.css — a modern, HTML5-ready alternative
to CSS resets.

As opposed to CSS resets, Normalize.css:

Expand All @@ -35,8 +35,7 @@ page](https://necolas.github.io/normalize.css/).

## main.css

Several base styles are included that build upon `Normalize.css`. These
styles:
Several base styles are included that build upon `Normalize.css`. These styles:

* provide basic typography settings that improve text readability
* protect against unwanted `text-shadow` during text highlighting
Expand All @@ -45,4 +44,8 @@ styles:
* style the prompt that is displayed to users using an outdated browser
* and more...

These styles are included in [main.css](https://github.com/h5bp/html5-boilerplate/blob/master/dist/css/main.css). See the [main.css](https://github.com/h5bp/main.css) project [documentation](https://github.com/h5bp/main.css/blob/master/README.md#features) for a full discussion of these styles.
These styles are included in
[main.css](https://github.com/h5bp/html5-boilerplate/blob/master/dist/css/main.css).
See the [main.css](https://github.com/h5bp/main.css) project
[documentation](https://github.com/h5bp/main.css/blob/master/README.md#features)
for a full discussion of these styles.
Loading

0 comments on commit 805d619

Please sign in to comment.