Skip to content

Commit 642c0e3

Browse files
craiggwilsoncraiggwilson
committed
added in reference layouts.
1 parent f27c3b4 commit 642c0e3

File tree

163 files changed

+40928
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

163 files changed

+40928
-0
lines changed

‎Docs/reference/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# MongoDB Java Driver Documentation
2+
3+
## Quick Start
4+
5+
1. Install hugo
6+
2. Create `./data/mongodb.toml`
7+
3. Create content
8+
9+
## Requirements
10+
Hugo version 0.13 [download here](https://github.com/spf13/hugo/releases/tag/v0.13)
11+
<br>
12+
Check out the hugo [quickstart guide](http://gohugo.io/overview/quickstart/).
13+
14+
## Running the server
15+
To run the server call the hugo command:
16+
17+
hugo server --baseUrl=http://localhost/ --buildDrafts --watch
18+
19+
| Options explained ||
20+
| --------------------------- |--------------------------------------------------------------------------|
21+
| server | Hugo runs its own webserver to render the files |
22+
| --baseUrl=http://localhost/ | Normally the base url will be /mongo-java-driver for gh-pages |
23+
| --buildDrafts | Include draft posts in the output - these won't be published to gh-pages |
24+
| -- watch | Automatically reloads on file change |
25+
26+
27+
All generated content will appear in the `./public` folder, so you can also check the filesystem and browse it locally.<br>
28+
For more hugo server options run: `hugo --help`
29+
30+
### Data
31+
32+
You *should* create `./data/mongodb.toml` and copy the `themes/mongodb/data/mongodb.toml` file and set the values as needed.
33+
34+
## Creating new content
35+
36+
Handy [markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet) will help with markdown issues and in markdown you can fall back to html if needed.
37+
38+
To create new content run: `hugo new <contentFileName>.md` and the new file will created in the `./content` directory and marked as a `draft`.
39+
40+
Its a good idea to group similar content together by placing it in a directory which can also be done by the `new` command eg: `hugo new tutorial/newTutorial.md`
41+
42+
### Menus
43+
Menu configuration generally goes in the content
44+
[front matter](http://gohugo.io/content/front-matter/). See the hugo [menu](http://gohugo.io/extras/menus/) docs, menus can also be configured in the top level `config.toml`.
45+
46+
The weight parameter relates to where it will appear in the menu starting with the lowest at the top and the highest at the bottom (heavy things sink).
47+
48+
## MongoDB Theme
49+
**Do not delete / change anything in themes**.<br>
50+
Currently, `./themes/mongodb` provides all templates and configuration. You can override *anything* by providing a top level version in the top level directory (`data, layouts, static`), so feel free to copy or add your own layouts.
51+
52+
You shouldn't edit the mongodb theme directly this will eventually be removed and live in its own repo for ease of sharing.

‎Docs/reference/config.toml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
baseurl = "/mongo-java-driver/3.0"
2+
languageCode = "en-us"
3+
title = "MongoDB Java Driver"
4+
theme = "mongodb"
5+
canonifyurls = false
6+
7+
# Example custom menu Item (Useful for linking to API docs)
8+
# [[menu.main]]
9+
# name = "Issues & Help"
10+
# pre = "<i class='fa fa-life-ring'></i>"
11+
# weight = 100
12+
# identifier = "help"
13+
# url = "https://jira.mongodb.org/browse/JAVA"

‎Docs/reference/data/.readme

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
custom data resources

‎Docs/reference/data/mongodb.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
githubRepo = "mongo-java-driver"
2+
githubBranch = "master"
3+
currentVersion = "3.0"
4+
driverVersions = ["3.0"]
5+
highlightTheme = "idea.css"
6+
apiUrl = "http://api.mongodb.org/java/3.0/"

‎Docs/reference/layouts/.readme

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
custom layouts here

‎Docs/reference/static/.readme

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Custom static resources

‎Docs/reference/themes/mongodb/LICENSE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This work is licensed under a [Creative Commons Attribution NonCommercial ShareAlike 3.0 Unported](http://creativecommons.org/licenses/by-nc-sa/3.0/) License.

‎Docs/reference/themes/mongodb/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# MongoDB Hugo Theme
2+
3+
## Quick Start
4+
5+
1. Install hugo
6+
2. Create your new site: `hugo new site <SITENAME>`
7+
3. Copy this theme to: `<SITENAME>/themes/mongodb`
8+
4. Add `theme = mongodb` to config.toml
9+
5. Create `<SITENAME>/data/mongodb.toml` and configure
10+
6. Create content
11+
12+
## Requirements
13+
Hugo version 0.13 [download here](https://github.com/spf13/hugo/releases/tag/v0.13)
14+
<br>
15+
Check out the hugo [quickstart guide](http://gohugo.io/overview/quickstart/).
16+
17+
## Running the server
18+
To run the server call the hugo command:
19+
20+
hugo server --baseUrl=http://localhost/ --buildDrafts --watch
21+
22+
| Options explained ||
23+
| --------------------------- |--------------------------------------------------------------------------|
24+
| server | Hugo runs its own webserver to render the files |
25+
| --baseUrl=http://localhost/ | Normally the base url will be /mongo-java-driver for gh-pages |
26+
| --buildDrafts | Include draft posts in the output - these won't be published to gh-pages |
27+
| -- watch | Automatically reloads on file change |
28+
29+
30+
All generated content will appear in the `./public` folder, so you can also check the filesystem and browse it locally.<br>
31+
For more hugo server options run: `hugo --help`
32+
33+
### Data
34+
35+
You *should* create `./data/mongodb.toml` and copy the `themes/mongodb/data/mongodb.toml` file and set the values as needed.
36+
37+
## Creating new content
38+
39+
Handy [markdown cheat sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet) will help with markdown issues and in markdown you can fall back to html if needed.
40+
41+
To create new content run: `hugo new <contentFileName>.md` and the new file will created in the `./content` directory and marked as a `draft`.
42+
43+
Its a good idea to group similar content together by placing it in a directory which can also be done by the `new` command eg: `hugo new tutorial/newTutorial.md`
44+
45+
### Menus
46+
Menu configuration generally goes in the content
47+
[front matter](http://gohugo.io/content/front-matter/). See the hugo [menu](http://gohugo.io/extras/menus/) docs, menus can also be configured in the top level `config.toml`.
48+
49+
The weight parameter relates to where it will appear in the menu starting with the lowest at the top and the highest at the bottom (heavy things sink).
50+
51+
## MongoDB Theme
52+
**Do not delete / change anything in themes**.<br>
53+
Currently, `./themes/mongodb` provides all templates and configuration. You can override *anything* by providing a top level version in the top level directory (`data, layouts, static`), so feel free to copy or add your own layouts.
54+
55+
You shouldn't edit the mongodb theme directly as it will be updated and any changes will be lost.

‎Docs/reference/themes/mongodb/archetypes/default.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
+++
2+
draft=true
3+
+++

‎Docs/reference/themes/mongodb/data/mongodb.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
githubRepo = ""
2+
githubBranch = ""
3+
currentVersion = ""
4+
driverVersions = []
5+
highlightTheme = "default.css"

0 commit comments

Comments
 (0)