This repository has been archived by the owner on Apr 19, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 39
/
about.html
60 lines (33 loc) · 3.15 KB
/
about.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# The Static, Static Blog Generator
### May 17th, 2014
We all like publishing our thoughts online - but why is it such a bother to run a CMS?
Managing databases, updating software, and keeping track of our content often cuts into the most important activity: *expressing ourselves*.
The web makes it really easy to share our thoughts with millions of individuals from around the world. With it we are able to talk about the things we love.
Online publishing platform have a problem though - they require certain software to be installed on web servers in order to work. This often means running your own server or paying someone else who will setup the required parts for you.
After you setup the system, constant updates are required to make sure that any bugs in the software you are running are patched immediately to prevent your site from being hacked. This often means having a recent backup of your database ready at all times.
## Can't we simplify?
Because running websites and managing databases isn't always worth the effort, "Static Content Generators" like [Dr. jekyll](http://jekyllrb.com/) and [Mr. Hyde](http://hyde.github.io/) have begun to gain traction as people pre-build websites and then place the static HTML results onto their server.
This means the web server doesn't need to be configured with any special software or databases - it simply serves the generated static HTML files.
However, you still have to install the generator and setup a "build" process of sorts after every article.
## Meet Jr.
`Jr` is a truly *static*, static content generator. All the processing of your files happens on the requesting client's computer as needed. The whole system is written in client-side JavaScript. This means:
- minimal bandwidth requirements
- better search engine indexing
- awesome screen reader support
- *zero* security vulnerabilities
- and more!
However, the neatest thing about `Jr` is that you don't have to configure, setup, or install _anything_! Simply download the files, create your articles, and upload everything to your server!
done.
## GIT thee hence
If you want to be really awesome you can use `Jr` along with the ever useful *version-control* system [git](https://help.github.com/articles/set-up-git). This allows you to keep better track of changes insuring that you can always rollback your text to recover previous versions - very handy if you work with a team!
## What About Markup?
Like most systems, you can compose pages in `Jr` using the text-to-HTML format "[markdown](http://daringfireball.net/projects/markdown/)". You can also use plain HTML if you want.
## Getting Started
1. [Download](http://github.com/Xeoncross/Jr) `Jr`
2. Make your `[article-name].html` files
3. Paste the following code at the bottom of each page:
<code><script src="jr.js"></script></code>
Once you have created your pages then simply upload the system to your website and enjoy.
*P.S. Looking for a static social lifestream application? Checkout [MicroStream](https://github.com/Xeoncross/microstream).*
<script src="js/jr.js"></script>