Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xeoncross/jr
Jr. the static, static javascript site generator (you should see this)
https://github.com/xeoncross/jr
Last synced: 3 months ago
JSON representation
Jr. the static, static javascript site generator (you should see this)
- Host: GitHub
- URL: https://github.com/xeoncross/jr
- Owner: xeoncross
- License: other
- Archived: true
- Created: 2014-05-17T18:56:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-11-02T08:18:16.000Z (about 4 years ago)
- Last Synced: 2024-08-01T00:45:32.143Z (3 months ago)
- Language: HTML
- Size: 53.7 KB
- Stars: 759
- Watchers: 25
- Forks: 39
- Open Issues: 20
-
Metadata Files:
- Readme: readme.md
- License: license.html
Awesome Lists containing this project
- awesome-starred - xeoncross/jr - Jr. the static, static javascript site generator (you should see this) (others)
README
# Welcome to Jr! (v1.2)
A static, static content generator that moves the "generator" part to the browser.
This site is pure text files with a single Javascript included on each page that renders
the theme and assets as needed.
Each page is written in markdown with a single `` tag that includes Jr.js. Once you have created your pages then simply upload the system to your website and enjoy.
Jr includes a [post editor](http://xeoncross.github.io/jr/editor.html) you can use to write your posts using a live preview of the rendered markdown. It uses `localStorage` to persist your writings even if you lose power.
## [Visit the Demo](http://xeoncross.github.io/jr)
## Getting Started
1. [Download](http://github.com/Xeoncross/Jr) `Jr`
2. Create an `[article-name].html` file
3. Paste the following code at the bottom of the page:
<code><script src="jr.js"></script></code>
4. `git commit` the new article or (sad face) SFTP it up to your web host
...and you're done! Rinse and repeat.
## Degrading gracefully in the absence of JavaScript
If you want the MarkDown content to appear as human-readable MarkDown text in browsers without JavaScript (instead of as an undelimited blob), add a line like this at the top of your documents:
\[enable JavaScript to render MarkDown\]: \<pre\>
This is a MarkDown comment that will not be rendered, but HTML renderers will see the \<pre\> tag and act accordingly.
## Background Images
For those of you who like to include photo mastheads or body background images on your posts. Simply add Markdown images tag with the name of the DOM element (prefixed with an underscore).
MIT License with ♡ from [David Pennington](http://davidpennington.me)
[Donate Stellar](https://www.stellar.org) to xeoncross