-
Notifications
You must be signed in to change notification settings - Fork 835
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
aef83ff
commit 2b06918
Showing
338 changed files
with
42,099 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,10 @@ | ||
.DS_Store | ||
public/ | ||
|
||
/static/scss/original/.sass-cache/ | ||
|
||
/static/theme-original/style.css.map | ||
|
||
/static/theme-flex/style.css.map | ||
|
||
.sass-cache |
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,22 @@ | ||
The MIT License (MIT) | ||
|
||
Copyright (c) 2014 Grav | ||
Copyright (c) 2016 MATHIEU CORNIC | ||
Copyright (c) 2017 Valere JEANTET | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of | ||
this software and associated documentation files (the "Software"), to deal in | ||
the Software without restriction, including without limitation the rights to | ||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of | ||
the Software, and to permit persons to whom the Software is furnished to do so, | ||
subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS | ||
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR | ||
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER | ||
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN | ||
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
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,126 @@ | ||
# Hugo docDock Theme | ||
|
||
This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Matcornic Learn theme](https://github.com/matcornic/hugo-theme-learn/). | ||
|
||
Visit the [theme documentation](http://docdock.netlify.com/) to see what is going on. It is actually built with this theme. | ||
|
||
# Main features | ||
|
||
- Search | ||
- **Unlimited menu levels** | ||
- RevealJS presentation from markdown (embededed or fullscreen page) | ||
- Attachments files | ||
- List child pages | ||
- Include segment of content from one page in another (Excerpt) | ||
- Automatic next/prev buttons to navigate through menu entries | ||
- Mermaid diagram | ||
- Icons, Buttons, Alerts, Panels, Tip/Note/Info/Warning boxes | ||
- Image resizing, shadow... | ||
- Customizable look and feel | ||
|
||
|
||
![Overview](https://github.com/vjeantet/hugo-theme-docdock/raw/master/images/tn.png) | ||
|
||
## Installation | ||
|
||
Check that your Hugo version is minimum `0.30` with `hugo version`. We assume that all changes to Hugo content and customizations are going to be tracked by git (GitHub, Bitbucket etc.). Develop locally, build on remote system. | ||
|
||
To start real work: | ||
|
||
1. Initialize Hugo | ||
2. Install DocDock theme | ||
3. Configure DocDock and Hugo | ||
|
||
### Prepare empty Hugo site | ||
|
||
Create empty directory, which will be root of your Hugo project. Navigate there and let Hugo to create minimal required directory structure: | ||
``` | ||
$ hugo new site . | ||
``` | ||
AFTER that, initialize this as git directory where to track further changes | ||
``` | ||
$ git init | ||
``` | ||
|
||
Next, there are at least three ways to install DocDock (first recommended): | ||
|
||
1. **As git submodule** | ||
2. As git clone | ||
3. As direct copy (from ZIP) | ||
|
||
Navigate to your themes folder in your Hugo site and use perform one of following scenarios. | ||
|
||
### 1. Install DocDock as git submodule | ||
DocDock will be added like a dependency repo to original project. When using CI tools like Netlify, Jenkins etc., submodule method is required, or you will get `theme not found` issues. Same applies when building site on remote server trough SSH. | ||
|
||
If submodule is no-go, use 3rd option. | ||
|
||
On your root of Hugo execute: | ||
|
||
``` | ||
$ git submodule add https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock | ||
``` | ||
Next initialize submodule for parent git repo: | ||
|
||
``` | ||
$ git submodule init | ||
$ git submodule update | ||
``` | ||
|
||
Now you are ready to add content and customize looks. Do not change any file inside theme directory. | ||
|
||
If you want to freeze changes to DocDock theme itself and use still submodules, fork private copy of DocDock and use that as submodule. When you are ready to update theme, just pull changes from origin to your private fork. | ||
|
||
### 2. Install DocDock simply as git clone | ||
This method results that files are checked out locally, but won't be visible from parent git repo. Probably you will build site locally with `hugo` command and use result from `public/` on your own. | ||
|
||
``` | ||
$ git clone https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock | ||
``` | ||
|
||
|
||
### 3. Install DocDock from ZIP | ||
|
||
All files from theme will be tracked inside parent repo, to update it, have to override files in theme. Download following zip and extract inside `themes/`. | ||
|
||
``` | ||
https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip | ||
``` | ||
Name of theme in next step will be `hugo-theme-docdock-master`, can rename as you wish. | ||
|
||
## Configure | ||
|
||
Import sample config from sample site to Hugo root. | ||
|
||
``` | ||
$ cp themes/docdock/exampleSite/config.toml . | ||
``` | ||
|
||
Change following `config.toml` line as needed, depending on method above: | ||
``` | ||
theme = "<hugo-theme-docdock-dir-name>" | ||
``` | ||
Comment out following line, so default `themes/` will be used: | ||
|
||
``` | ||
# themesdir = "../.." | ||
``` | ||
|
||
#### (Bonus) | ||
Create empty file `.gitkeep` inside `public/` and add following to `.gitignore`. This way it will keep repo smaller and won't bring build result files and errors to remote checkout places: | ||
``` | ||
/public/* | ||
!/public/.gitkeep | ||
``` | ||
|
||
### Preview site | ||
``` | ||
$ hugo server | ||
``` | ||
to browse site on http://localhost:1313 | ||
|
||
## Usage | ||
|
||
- [Visit the documentation](http://docdock.netlify.com/) | ||
- [Hugo docs](https://gohugo.io/getting-started/configuration/) | ||
- [Git submodules](https://git-scm.com/docs/git-submodule) |
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,9 @@ | ||
+++ | ||
title= "{{ replace .TranslationBaseName "-" " " | title }}" | ||
date= {{ .Date }} | ||
description = "" | ||
draft= true | ||
+++ | ||
|
||
Lorem Ipsum. | ||
Notice `draft` is set to true. |
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,46 @@ | ||
+++ | ||
title = "Slide title" | ||
type="slide" | ||
|
||
theme = "league" | ||
[revealOptions] | ||
transition= 'concave' | ||
controls= true | ||
progress= true | ||
history= true | ||
center= true | ||
+++ | ||
|
||
# Slide 1 | ||
|
||
___ | ||
|
||
## Slide 1.1 | ||
|
||
- Turn off alarm | ||
- Get out of bed | ||
|
||
___ | ||
|
||
## Slide 1.2 | ||
|
||
- Eat eggs | ||
- Drink coffee | ||
|
||
--- | ||
|
||
# Slide 2 | ||
|
||
___ | ||
|
||
## Slide 2.1 | ||
|
||
- Eat spaghetti | ||
- Drink wine | ||
|
||
___ | ||
|
||
## Slide 2.2 | ||
|
||
- Get in bed | ||
- Count sheep |
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,44 @@ | ||
baseURL = "/" | ||
languageCode = "en-us" | ||
DefaultContentLanguage = "en" | ||
|
||
title = "Docdock" | ||
theme = "hugo-theme-docdock" | ||
themesdir = "../.." | ||
|
||
[params] | ||
editURL = "https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/" | ||
showVisitedLinks = true # default is false | ||
themeStyle = "original" # "original" or "flex" # default "original" | ||
themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default) | ||
ordersectionsby = "weight" # ordersectionsby = "title" | ||
disableHomeIcon = false # default is false | ||
disableSearch = false # default is false | ||
disableNavChevron = false # set true to hide next/prev chevron, default is false | ||
|
||
[outputs] | ||
home = [ "HTML", "RSS", "JSON"] | ||
|
||
|
||
[[menu.shortcuts]] | ||
pre = "<h3>More</h3>" | ||
name = "<i class='fa fa-github'></i> Github repo" | ||
identifier = "ds" | ||
url = "https://github.com/vjeantet/hugo-theme-docdock" | ||
weight = 10 | ||
|
||
[[menu.shortcuts]] | ||
name = "<i class='fa fa-camera'></i> Showcases" | ||
url = "/showcase" | ||
weight = 11 | ||
|
||
[[menu.shortcuts]] | ||
name = "<i class='fa fa-bookmark'></i> Hugo Documentation" | ||
identifier = "hugodoc" | ||
url = "https://gohugo.io/" | ||
weight = 20 | ||
|
||
[[menu.shortcuts]] | ||
name = "<i class='fa fa-bullhorn'></i> Credits" | ||
url = "/credits" | ||
weight = 30 |
11 changes: 11 additions & 0 deletions
11
docs/themes/hugo-theme-docdock/exampleSite/content/_footer.md
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,11 @@ | ||
+++ | ||
title = "footer" | ||
description = "" | ||
date = "2017-04-24T18:36:24+02:00" | ||
+++ | ||
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. |
6 changes: 6 additions & 0 deletions
6
docs/themes/hugo-theme-docdock/exampleSite/content/_header.md
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,6 @@ | ||
+++ | ||
title = "header" | ||
description = "" | ||
date = "2017-04-24T18:36:24+02:00" | ||
+++ | ||
DocDock Documentation |
52 changes: 52 additions & 0 deletions
52
docs/themes/hugo-theme-docdock/exampleSite/content/_index.md
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,52 @@ | ||
+++ | ||
title = "DocDock Theme for Hugo" | ||
description = "" | ||
date = "2017-04-24T18:36:24+02:00" | ||
|
||
+++ | ||
|
||
# Hugo docDock theme | ||
[Hugo-theme-docdock {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docdock) is a theme for Hugo, a fast and modern static website engine written in Go. Hugo is often used for blogs, **this theme is fully designed for documentation.** | ||
|
||
This theme is a partial porting of the [Learn theme of matcornic {{%icon fa-github%}}](https://github.com/matcornic/hugo-theme-learn). | ||
|
||
{{%panel%}}docDock works with a "page tree structure" to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "content-organisation/_index.md"%}}) {{%/panel%}} | ||
|
||
## Main features | ||
|
||
* [Search]({{%relref "search/_index.md" %}}) | ||
* **Unlimited menu levels** | ||
* [Generate RevealJS presentation]({{%relref "page-slide.md"%}}) from markdown (embededed or fullscreen page) | ||
* Automatic next/prev buttons to navigate through menu entries | ||
* [Image resizing, shadow...]({{%relref "create-page/page-images.md" %}}) | ||
* [Attachments files]({{%relref "shortcodes/attachments.md" %}}) | ||
* [List child pages]({{%relref "shortcodes/children/_index.md" %}}) | ||
* [Excerpt]({{%relref "shortcodes/excerpt.md"%}}) ! Include segment of content from one page in another | ||
* [Mermaid diagram]({{%relref "shortcodes/mermaid.md" %}}) (flowchart, sequence, gantt) | ||
* [Icons]({{%relref "shortcodes/icon.md" %}}), [Buttons]({{%relref "shortcodes/button.md" %}}), [Alerts]({{%relref "shortcodes/alert.md" %}}), [Panels]({{%relref "shortcodes/panel.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.md" %}}), [Expand]({{%relref "shortcodes/expand.md" %}}) | ||
* [customizable look and feel]({{%relref "content-organisation/customize-style/_index.md"%}}), [theme style]({{%relref "content-organisation/customize-style/themestyle.md"%}}), [theme variants]({{%relref "content-organisation/customize-style/theme-variants.md"%}}) | ||
|
||
|
||
|
||
Style "Original" | ||
|
||
![](https://raw.githubusercontent.com/vjeantet/hugo-theme-docdock/master/images/tn.png?width=33pc&classes=border,shadow) | ||
|
||
Style "Flex" | ||
|
||
![](style-flexfull.png?width=33pc&classes=border,shadow) | ||
|
||
## Contribute to this documentation | ||
Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it | ||
{{%alert%}}Your modification will be deployed automatically when merged.{{%/alert%}} | ||
|
||
|
||
## Documentation website | ||
This current documentation has been statically generated with Hugo with a simple command : `hugo -t docdock` -- source code is [available here at GitHub {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docDock) | ||
|
||
{{% panel theme="success" header="Automated deployments" footer="Netlify builds, deploys, and hosts frontends." %}} | ||
Automatically published and hosted thanks to [Netlify](https://www.netlify.com/). | ||
|
||
Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/) | ||
{{% /panel %}} | ||
|
Oops, something went wrong.