https://github.com/iansinnott/reference
A concise, self-hosted language reference. Based on Learn X In Y Minutes.
https://github.com/iansinnott/reference
Last synced: 2 months ago
JSON representation
A concise, self-hosted language reference. Based on Learn X In Y Minutes.
- Host: GitHub
- URL: https://github.com/iansinnott/reference
- Owner: iansinnott
- Created: 2014-10-06T16:16:33.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-11-27T09:23:22.000Z (over 11 years ago)
- Last Synced: 2025-06-08T15:04:15.343Z (about 1 year ago)
- Language: CSS
- Homepage: http://reference.isinn.co/
- Size: 935 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Reference Docs
An augmented clone of [Learn X In Y Minutes][learn]. Live site at .
## Why?
I wanted to add specific notes to the reference docs found on LXIYM, but most of my additions are probably to specific to warrant making a pull request. As such, this is basically my own private version. Feel free to use it :grinning:. Or if you want to host your own reference then fork away.
## What's Included
This repository contains the code for the live site found at , but all documentation is contained in a submodule. In my case, I forked the [learn x in y minutes docs][repo] so that I could maintain my own copy with edits and notes.
The main content is intentionally decoupled from the web app. This allows easy updating of the documentation code, either by merging in the latest changes from the official repo or by creating new content of your own.
[learn]: http://learnxinyminutes.com
[repo]: https://github.com/adambard/learnxinyminutes-docs
## Development
To start developing, simply clone the repo and run:
```
$ npm install
$ gulp
```
The `gulp deps` task will copy over most dependencies. The mfizz font is no acception but since it wasn't on NPM I needed to put it's source elsewhere. It's source CSS resides in `/stylesheets/font-mfizz.css`. The CSS was modified slightly to provide a different font path from the default. The font files were just copied directly into `/public/fonts`. As such they are checked into the project, so cloning should not be a problem.
Octicons are also included manually as they are not present on NPM. They exist on bower, but using two package managers just seems silly. The fonts were added manually to the `/public/fonts` directory. CSS resides in `/stylesheets/octicons.css` and is concatenated and minified along with other CSS dependencies.
## License
The majority of the content on this site is taken directly from the [Learn X in Y Minutes][learnrepo] project. From the GitHub project page:
> Contributors retain copyright to their work, and can request removal at any time.
> By uploading a doc here, you agree to publish your work under the default
> [Creative Commons Attribution-ShareAlike 3.0 Unported](http://creativecommons.org/licenses/by-sa/3.0/deed.en_US)
> licensing included on each doc page.
Anything else not covered by that is free for you to use as you like.
[learnrepo]: https://github.com/adambard/learnxinyminutes-docs