forked from akveo/blur-admin
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(general): add wintersmith static website generator with document…
…ation template
- Loading branch information
Showing
24 changed files
with
2,549 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"baseUrl": "/blur-admin/", | ||
"locals": { | ||
"url": "http://localhost:8080", | ||
"name": "The Wintersmith's blog", | ||
"owner": "Someone", | ||
"description": "Ramblings of an immor(t)al demigod" | ||
}, | ||
"plugins": [ | ||
"./plugins/paginator.coffee" | ||
], | ||
"require": { | ||
"moment": "moment", | ||
"_": "underscore", | ||
"typogr": "typogr" | ||
}, | ||
"jade": { | ||
"pretty": true | ||
}, | ||
"markdown": { | ||
"smartLists": true, | ||
"smartypants": true | ||
}, | ||
"paginator": { | ||
"perPage": 3, | ||
"groupSort": { | ||
"First Group": 100, | ||
"Second Group": 200, | ||
"Third Group": 50 | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
--- | ||
title: Code and stuff! | ||
author: the-wintersmith | ||
sort: 100 | ||
group: First Group | ||
template: article.jade | ||
--- | ||
|
||
Syntax highlighting with [highlight.js](http://softwaremaniacs.org/soft/highlight/en/). | ||
The theme used is tomorrow, you can find more themes [here](http://jmblog.github.io/color-themes-for-highlightjs/). | ||
|
||
<span class="more"></span> | ||
|
||
### JavaScript | ||
|
||
```javascript | ||
function getRandomNumber() { | ||
return 4; // chosen by fair dice roll. | ||
// guaranteed to be random. | ||
} | ||
``` | ||
|
||
### CoffeeScript | ||
|
||
```coffeescript | ||
class Animal | ||
### Intellegent design ### | ||
getDNA: -> | ||
print 'sequencing...' | ||
while true | ||
sleep 1 | ||
|
||
class Monkey extends Animal | ||
speak: -> | ||
print 'ah ah ah' | ||
|
||
class Human extends Monkey | ||
speak: -> | ||
print ['yolo' unless i % 3] + ['swag' unless i % 5] or i for i in [1..100] | ||
``` | ||
|
||
### C | ||
|
||
```c | ||
#include <stdio.h> | ||
|
||
int main(void) | ||
{ | ||
printf("Hello world\n"); | ||
return 0; | ||
} | ||
``` | ||
### C++ | ||
```cpp | ||
#include <iostream> | ||
int main() | ||
{ | ||
std::cout << "Hello World!" << std::endl; | ||
return 0; | ||
} | ||
``` | ||
|
||
### C-sharp | ||
|
||
```cs | ||
class ExampleClass | ||
{ | ||
static void Main() | ||
{ | ||
System.Console.WriteLine("Hello, world!"); | ||
} | ||
} | ||
``` | ||
|
||
### Erlang | ||
|
||
```erlang | ||
io:format("~s~n", ["hello, world"]) | ||
``` | ||
|
||
### Go | ||
|
||
```go | ||
package main | ||
|
||
import "fmt" | ||
|
||
func main() { | ||
fmt.Println("Hello World!") | ||
} | ||
``` | ||
|
||
### Java | ||
|
||
```java | ||
public class HelloWorld { | ||
public static void main(String[] args) { | ||
System.out.println("Hello world!"); | ||
} | ||
} | ||
``` | ||
|
||
### ObjectiveC | ||
|
||
```objectivec | ||
#import <stdio.h> | ||
|
||
int main(void) | ||
{ | ||
printf("Hello, World!\n"); | ||
return 0; | ||
} | ||
``` | ||
### PHP | ||
```php | ||
<?php echo 'Hello, world'; ?> | ||
``` | ||
|
||
### Python | ||
|
||
```python | ||
print("Hello World") | ||
``` | ||
|
||
### Ruby | ||
|
||
```ruby | ||
puts "Hello world!" | ||
``` |
Large diffs are not rendered by default.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
--- | ||
title: README | ||
author: the-wintersmith | ||
sort: 65 | ||
group: First Group | ||
template: article.jade | ||
--- | ||
|
||
Welcome to your new blog! This is the default blog template with RSS, pagination and an archive. There are other templates available -- run `wintersmith new --help` to list them. | ||
|
||
## _Repeat after me:_ This is my blog. There are many like it, but this one is mine. My blog is my best friend. It is my life. I must master it as I must master my life. My blog, without me, is useless. Without my blog, I am useless. | ||
|
||
Good, now, the directory structure of your blog is as follows: | ||
|
||
``` | ||
├── config.json <- site configuration | ||
├── contents | ||
│ ├── about.md | ||
│ ├── archive.json | ||
│ ├── articles <– each article has its own directory | ||
│ │ ├── another-test | ||
│ │ │ └── index.md | ||
│ │ ├── bamboo-cutter | ||
│ │ │ ├── index.md | ||
│ │ │ └── taketori_monogatari.jpg | ||
│ │ ├── hello-world | ||
│ │ │ └── index.md | ||
│ │ ├── markdown-syntax | ||
│ │ │ └── index.md | ||
│ │ └── red-herring | ||
│ │ ├── banana.png | ||
│ │ └── index.md | ||
│ ├── authors <- author metadata, check author.jade | ||
│ │ ├── baker.json | ||
│ │ └── the-wintersmith.json | ||
│ ├── css | ||
│ │ └── main.css | ||
│ └── feed.json | ||
├── plugins | ||
│ └── paginator.coffee <- paginator plugin | ||
├── templates | ||
│ ├── archive.jade | ||
│ ├── article.jade | ||
│ ├── author.jade | ||
│ ├── feed.jade | ||
│ ├── index.jade | ||
│ └── layout.jade | ||
└── views | ||
└── articles.coffee <- view that lists articles | ||
``` | ||
|
||
Articles are sorted by date and 3 are shown per page, you can configure this and more in config.json. Check paginator.coffee for all options related to pagination, most plugins also have their own options. | ||
|
||
### A typical article | ||
|
||
```markdown | ||
--- | ||
title: Hear me blog | ||
author: johndoe | ||
date: 2012-12-12 12:12 | ||
--- | ||
|
||
This will be shown as the article excerpt. | ||
|
||
## A h2, hr or <span class="more"> marks where the intro cuts off | ||
|
||
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod | ||
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, | ||
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo | ||
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse | ||
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non | ||
proident, sunt in culpa qui officia deserunt mollit anim id est laborum. | ||
|
||
``` | ||
|
||
## Links in the markdown to other items in the content tree will be resolved for you. | ||
|
||
For example a link to `../bamboo-cutter/index.md` resolves to [`/articles/bamboo-cutter/`](../bamboo-cutter/index.md). | ||
|
||
--- | ||
|
||
This is where I leave you to your own devices. Join **#wintersmith** on freenode if you have any questions. |
Oops, something went wrong.