-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Dipankar Das <[email protected]>
- Loading branch information
1 parent
5bd5876
commit 06e43f9
Showing
7 changed files
with
552 additions
and
0 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,8 @@ | ||
--- | ||
title: Blog | ||
menu: {main: {weight: 30}} | ||
--- | ||
|
||
This is the **blog** section. It has two categories: News and Releases. | ||
|
||
Files in these directories will be listed in reverse chronological order. |
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,4 @@ | ||
--- | ||
title: News | ||
weight: 20 | ||
--- |
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,48 @@ | ||
--- | ||
date: 2018-10-06 | ||
title: Easy documentation with Docsy | ||
linkTitle: Announcing Docsy | ||
description: > | ||
The Docsy Hugo theme lets project maintainers and contributors focus on content, | ||
not on reinventing a website infrastructure from scratch | ||
author: Riona MacNamara ([@rionam](https://twitter.com/bepsays)) | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
params: | ||
byline: "Photo: Riona MacNamara / CC-BY-CA" | ||
--- | ||
|
||
**This is a typical blog post that includes images.** | ||
|
||
The front matter specifies the date of the blog post, its title, a short description that will be displayed on the blog landing page, and its author. | ||
|
||
## Including images | ||
|
||
Here's an image (`featured-sunset-get.png`) that includes a byline and a caption. | ||
|
||
{{< imgproc sunset Fill "600x300" >}} | ||
Fetch and scale an image in the upcoming Hugo 0.43. | ||
{{< /imgproc >}} | ||
|
||
The front matter of this post specifies properties to be assigned to all image resources: | ||
|
||
``` | ||
resources: | ||
- src: "**.{png,jpg}" | ||
title: "Image #:counter" | ||
params: | ||
byline: "Photo: Riona MacNamara / CC-BY-CA" | ||
``` | ||
|
||
To include the image in a page, specify its details like this: | ||
|
||
``` | ||
{{< imgproc sunset Fill "600x300" >}} | ||
Fetch and scale an image in the upcoming Hugo 0.43. | ||
{{< /imgproc >}} | ||
``` | ||
|
||
The image will be rendered at the size and byline specified in the front matter. | ||
|
||
|
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,244 @@ | ||
--- | ||
title: Second blog post | ||
date: 2018-10-06 | ||
description: > | ||
A short lead description about this content page. Text here can also be | ||
**bold** or _italic_ and can even be split over multiple paragraphs. | ||
--- | ||
|
||
Text can be **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com) should be blue with no underlines (unless hovered over). | ||
|
||
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. | ||
|
||
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. | ||
|
||
> There should be no margin above this first sentence. | ||
> | ||
> Blockquotes should be a lighter gray with a border along the left side in the secondary color. | ||
> | ||
> There should be no margin below this final sentence. | ||
## First Header | ||
|
||
This is a normal paragraph following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
|
||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
On big screens, paragraphs and headings should not take up the full container width, but we want tables, code blocks and similar to take the full width. | ||
|
||
Lorem markdownum tuta hospes stabat; idem saxum facit quaterque repetito | ||
occumbere, oves novem gestit haerebat frena; qui. Respicit recurvam erat: | ||
pignora hinc reppulit nos **aut**, aptos, ipsa. | ||
|
||
Meae optatos *passa est* Epiros utiliter *Talibus niveis*, hoc lata, edidit. | ||
Dixi ad aestum. | ||
|
||
## Header 2 | ||
|
||
> This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
### Header 3 | ||
|
||
``` | ||
This is a code block following a header. | ||
``` | ||
|
||
#### Header 4 | ||
|
||
* This is an unordered list following a header. | ||
* This is an unordered list following a header. | ||
* This is an unordered list following a header. | ||
|
||
##### Header 5 | ||
|
||
1. This is an ordered list following a header. | ||
2. This is an ordered list following a header. | ||
3. This is an ordered list following a header. | ||
|
||
###### Header 6 | ||
|
||
| What | Follows | | ||
|-----------|-----------------| | ||
| A table | A header | | ||
| A table | A header | | ||
| A table | A header | | ||
|
||
---------------- | ||
|
||
There's a horizontal rule above and below this. | ||
|
||
---------------- | ||
|
||
Here is an unordered list: | ||
|
||
* Salt-n-Pepa | ||
* Bel Biv DeVoe | ||
* Kid 'N Play | ||
|
||
And an ordered list: | ||
|
||
1. Michael Jackson | ||
2. Michael Bolton | ||
3. Michael Bublé | ||
|
||
And an unordered task list: | ||
|
||
- [x] Create a sample markdown document | ||
- [x] Add task lists to it | ||
- [ ] Take a vacation | ||
|
||
And a "mixed" task list: | ||
|
||
- [ ] Steal underpants | ||
- ? | ||
- [ ] Profit! | ||
|
||
And a nested list: | ||
|
||
* Jackson 5 | ||
* Michael | ||
* Tito | ||
* Jackie | ||
* Marlon | ||
* Jermaine | ||
* TMNT | ||
* Leonardo | ||
* Michelangelo | ||
* Donatello | ||
* Raphael | ||
|
||
Definition lists can be used with Markdown syntax. Definition terms are bold. | ||
|
||
Name | ||
: Godzilla | ||
|
||
Born | ||
: 1952 | ||
|
||
Birthplace | ||
: Japan | ||
|
||
Color | ||
: Green | ||
|
||
|
||
---------------- | ||
|
||
Tables should have bold headings and alternating shaded rows. | ||
|
||
| Artist | Album | Year | | ||
|-------------------|-----------------|------| | ||
| Michael Jackson | Thriller | 1982 | | ||
| Prince | Purple Rain | 1984 | | ||
| Beastie Boys | License to Ill | 1986 | | ||
|
||
If a table is too wide, it should scroll horizontally. | ||
|
||
| Artist | Album | Year | Label | Awards | Songs | | ||
|-------------------|-----------------|------|-------------|----------|-----------| | ||
| Michael Jackson | Thriller | 1982 | Epic Records | Grammy Award for Album of the Year, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Selling Album, Grammy Award for Best Engineered Album, Non-Classical | Wanna Be Startin' Somethin', Baby Be Mine, The Girl Is Mine, Thriller, Beat It, Billie Jean, Human Nature, P.Y.T. (Pretty Young Thing), The Lady in My Life | | ||
| Prince | Purple Rain | 1984 | Warner Brothers Records | Grammy Award for Best Score Soundtrack for Visual Media, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Soundtrack/Cast Recording, Grammy Award for Best Rock Performance by a Duo or Group with Vocal | Let's Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I'm a Star, Purple Rain | | ||
| Beastie Boys | License to Ill | 1986 | Mercury Records | noawardsbutthistablecelliswide | Rhymin & Stealin, The New Style, She's Crafty, Posse in Effect, Slow Ride, Girls, (You Gotta) Fight for Your Right, No Sleep Till Brooklyn, Paul Revere, Hold It Now, Hit It, Brass Monkey, Slow and Low, Time to Get Ill | | ||
|
||
---------------- | ||
|
||
Code snippets like `var foo = "bar";` can be shown inline. | ||
|
||
Also, `this should vertically align` ~~`with this`~~ ~~and this~~. | ||
|
||
Code can also be shown in a block element. | ||
|
||
``` | ||
foo := "bar"; | ||
bar := "foo"; | ||
``` | ||
|
||
Code can also use syntax highlighting. | ||
|
||
```go | ||
func main() { | ||
input := `var foo = "bar";` | ||
|
||
lexer := lexers.Get("javascript") | ||
iterator, _ := lexer.Tokenise(nil, input) | ||
style := styles.Get("github") | ||
formatter := html.New(html.WithLineNumbers()) | ||
|
||
var buff bytes.Buffer | ||
formatter.Format(&buff, style, iterator) | ||
|
||
fmt.Println(buff.String()) | ||
} | ||
``` | ||
|
||
``` | ||
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this. | ||
``` | ||
|
||
Inline code inside table cells should still be distinguishable. | ||
|
||
| Language | Code | | ||
|-------------|--------------------| | ||
| Javascript | `var foo = "bar";` | | ||
| Ruby | `foo = "bar"{` | | ||
|
||
---------------- | ||
|
||
Small images should be shown at their actual size. | ||
|
||
![](https://placekitten.com/g/300/200/) | ||
|
||
Large images should always scale down and fit in the content container. | ||
|
||
![](https://placekitten.com/g/1200/800/) | ||
|
||
## Components | ||
|
||
### Alerts | ||
|
||
{{< alert >}}This is an alert.{{< /alert >}} | ||
{{< alert title="Note:" >}}This is an alert with a title.{{< /alert >}} | ||
{{< alert type="success" >}}This is a successful alert.{{< /alert >}} | ||
{{< alert type="warning" >}}This is a warning!{{< /alert >}} | ||
{{< alert type="warning" title="Warning!" >}}This is a warning with a title!{{< /alert >}} | ||
|
||
|
||
## Sizing | ||
|
||
Add some sections here to see how the ToC looks like. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
### Parameters available | ||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
### Using pixels | ||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
### Using rem | ||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
## Memory | ||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
### RAM to use | ||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
### More is better | ||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
### Used RAM | ||
|
||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. | ||
|
||
|
||
|
||
``` | ||
This is the final element on the page and there should be no margin below this. | ||
``` |
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,4 @@ | ||
--- | ||
title: Releases | ||
weight: 20 | ||
--- |
Oops, something went wrong.