Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/htanjo/githubish.css
Tiny CSS for GitHub-ish Markdown styles
https://github.com/htanjo/githubish.css
Last synced: about 2 months ago
JSON representation
Tiny CSS for GitHub-ish Markdown styles
- Host: GitHub
- URL: https://github.com/htanjo/githubish.css
- Owner: htanjo
- License: mit
- Created: 2014-10-27T02:54:04.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-09-13T03:48:12.000Z (over 8 years ago)
- Last Synced: 2024-11-10T03:03:28.578Z (2 months ago)
- Language: CSS
- Homepage: http://htanjo.github.io/githubish.css
- Size: 60.5 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# githubish.css
> Tiny CSS for GitHub-ish Markdown styles.
[![npm Version][npm-image]][npm-url]
[![Bower Version][bower-image]][bower-url]
## Demo
* [Fixed layout](http://htanjo.github.io/githubish.css/)
* [Fluid layout](http://htanjo.github.io/githubish.css/fluid.html)
## Overview
This CSS arranges plain HTML as GitHub style Markdown document.
githubish.css is based on [github-markdown-css](https://github.com/sindresorhus/github-markdown-css), but designed for non-classed HTML.
**github-markdown-css:**
* Needs wrapper element with `.markdown-body` class.
* Supports every style including GitHub doc extensions: e.g. anchor, syntax highlighting, ...
**githubish.css:**
* Works on plain HTML without any classes.
* Only contains styles for pure HTML elements generated from Markdown.
Both libraries are generated automatically using the production code of GitHub.
## Downloads
* **[githubish.css](https://raw.githubusercontent.com/htanjo/githubish.css/master/dist/githubish.css)** / [minified](https://raw.githubusercontent.com/htanjo/githubish.css/master/dist/githubish.min.css)
980px centered layout with borders. Similar to README document in GitHub.
* **[githubish-fluid.css](https://raw.githubusercontent.com/htanjo/githubish.css/master/dist/githubish-fluid.css)** / [minified](https://raw.githubusercontent.com/htanjo/githubish.css/master/dist/githubish-fluid.min.css)
100% fluid width. This is suitable for generic document.
Or install with package manager: [npm](https://www.npmjs.com/), [Bower](http://bower.io/)
```sh
$ npm install --save githubish
```
```sh
$ bower install --save githubish
```
## Usage
Just import "githubish.css" to your HTML.
```html
Document
Github-ish Markdown
Write your document here!
```
## Build
Generate CSS files from the latest GitHub's stylesheets.
```sh
$ npm install
$ npm run build
# Output CSS files into "dist" folder.
```
## License
Copyright (c) 2014-2016 Hiroyuki Tanjo.
Licensed under the [MIT License](https://github.com/htanjo/githubish.css/blob/master/LICENSE).
[npm-image]: https://img.shields.io/npm/v/githubish.svg
[npm-url]: https://www.npmjs.com/package/githubish
[bower-image]: https://img.shields.io/bower/v/githubish.svg
[bower-url]: http://bower.io/