Skip to content

Commit ba7f2b2

Browse files
committed
Added Basic empty frame for driver docs
1 parent 92168c6 commit ba7f2b2

File tree

108 files changed

+11801
-8
lines changed

Some content is hidden

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

108 files changed

+11801
-8
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ pids
1212
lib-cov
1313
data/
1414
out/
15+
docs/public
1516

1617
# Directory for dbs
1718
db

.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ test/
2222
out/
2323
performance/
2424
.coverage_data/
25+
docs/public
2526

2627
external-libs/bson/build/
2728
external-libs/bson/build/.wafpickle-7

docs/archetypes/default.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
+++
2+
weight = 5
3+
[menu]
4+
[menu.main]
5+
parent = "x"
6+
+++

docs/archetypes/showcase.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
date: 2013-07-01T07:32:00Z
3+
description: ""
4+
license: ""
5+
licenseLink: ""
6+
sitelink: http://spf13.com
7+
sourceLink: http://github.com/spf13/spf13.com
8+
tags:
9+
- personal
10+
- blog
11+
thumbnail: /img/spf13-tn.jpg
12+
title: spf13.com
13+
---
14+

docs/articles/aggregation.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/articles/connecting.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/articles/crud_operations.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/articles/gridfs.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/articles/installing.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/articles/querying.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/articles/streams.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/articles/urls.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/config.toml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
baseurl = "http://mongodb.github.io"
2+
MetaDataFormat = "yaml"
3+
4+
[indexes]
5+
tag = "tags"
6+
group = "groups"
7+
8+
[[menu.main]]
9+
name = "api"
10+
pre = "<i class='fa fa-file-text'></i>"
11+
weight = -90
12+
[[menu.main]]
13+
name = "about driver"
14+
pre = "<i class='fa fa-gift'></i>"
15+
weight = -110
16+
identifier = "about"
17+
[[menu.main]]
18+
name = "getting started"
19+
pre = "<i class='fa fa-road'></i>"
20+
weight = -100
21+
[[menu.main]]
22+
name = "tutorials"
23+
pre = "<i class='fa fa-book'></i>"
24+
weight = -40
25+
[[menu.main]]
26+
name = "community"
27+
pre = "<i class='fa fa-group'></i>"
28+
weight = -50
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
aliases:
3+
- /doc/contributing/
4+
- /meta/contributing/
5+
date: 2013-07-01
6+
menu:
7+
main:
8+
parent: community
9+
next: /tutorials/github_pages_blog
10+
prev: /community/press
11+
title: Contributing to Hugo
12+
weight: 30
13+
---
14+
15+
All contributions to Hugo are welcome. Whether you want to scratch an itch, or simply contribute to the project, feel free to pick something from the roadmap
16+
or contact [spf13](http://spf13.com) about what may make sense
17+
to do next.
18+
19+
You should fork the project and make your changes. *We encourage pull requests to discuss code changes.*
20+
21+
22+
When you're ready to create a pull request, be sure to:
23+
24+
* Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
25+
* Run `go fmt`
26+
* Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request.
27+
* Make sure `go test ./...` passes, and `go build` completes. Our Travis CI loop will catch most things that are missing. The exception: Windows. We run on Windows from time to time, but if you have access, please check on a Windows machine too.
28+
29+
## Contribution Overview
30+
31+
1. Fork Hugo from https://github.com/spf13/hugo
32+
2. Create your feature branch (`git checkout -b my-new-feature`)
33+
3. Commit your changes (`git commit -am 'Add some feature'`)
34+
4. Commit passing tests to validate changes.
35+
5. Run `go fmt`
36+
6. Squash commits into a single (or logically grouped) commits (`git rebase -i`)
37+
7. Push to the branch (`git push origin my-new-feature`)
38+
8. Create new Pull Request
39+
40+
41+
# Building from source
42+
43+
## Clone locally (for contributors):
44+
45+
git clone https://github.com/spf13/hugo
46+
cd hugo
47+
go get
48+
49+
Because Go expects all of your libraries to be found in either
50+
$GOROOT or $GOPATH, it's helpful to symlink the project to one
51+
of the following paths:
52+
53+
* ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo
54+
* ln -s /path/to/your/hugo $GOROOT/src/pkg/github.com/spf13/hugo
55+
56+
## Running Hugo
57+
58+
cd /path/to/hugo
59+
go install github.com/spf13/hugo/hugo
60+
go run main.go
61+
62+
## Building Hugo
63+
64+
cd /path/to/hugo
65+
go build -o hugo main.go
66+
mv hugo /usr/local/bin/
67+
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
date: 2013-07-01
3+
menu:
4+
main:
5+
parent: community
6+
next: /community/press
7+
prev: /extras/urls
8+
title: Mailing List
9+
weight: 10
10+
---
11+
12+
Hugo has two mailing lists:
13+
14+
## Announcements
15+
Very low traffic. Only releases will be emailed here.
16+
17+
https://groups.google.com/forum/#!forum/hugo-announce
18+
19+
## Discussion
20+
For all questions and discussions:
21+
22+
https://groups.google.com/forum/#!forum/hugo-discuss
23+
24+
# Other Resources
25+
26+
## GoNuts
27+
28+
For general Go questions or discussion please refer to the Go mailing list.
29+
30+
https://groups.google.com/forum/#!forum/golang-nuts
31+
32+
## GitHub Issues
33+
34+
https://github.com/spf13/hugo/issues
35+
36+
## Twitter
37+
38+
Hugo doesn't have its own Twitter handle, but feel free to tweet [@spf13](http://twitter.com/spf13).

docs/content/community/press.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
date: 2014-03-24T20:00:00Z
3+
linktitle: Press
4+
menu:
5+
main:
6+
parent: community
7+
next: /community/contributing
8+
notoc: true
9+
prev: /community/mailing-list
10+
title: Press, Blogs and Media Coverage
11+
weight: 20
12+
---
13+
14+
Hugo has been featured in the following Blog Posts, Press and Media.
15+
16+
17+
| Title | Author | Date |
18+
| ------ | ------ | -----: |
19+
| [Hugo para crear sitios web estáticos](http://www.webbizarro.com/noticias/1076/hugo-para-crear-sitios-web-estaticos/) | Web Bizarro | 19 Aug 2014 |
20+
| [Hello Hugo!](http://commiechink.com/2014/08/hello-hugo/) | Jason Yee | 19 Aug 2014 |
21+
| [Going with hugo](http://www.markuseliasson.se/article/going-with-hugo/) | Markus Eliasson | 18 Aug 2014 |
22+
| [Benchmarking Jekyll, Hugo and Wintersmith](http://www.internaldeployment.se/post/2014-08-12-Jekyll-and-its-alternatives-from-a-site-generation-point-of-view/) | Fredrik Loch | 12 Aug 2014 |
23+
| [Goodbye Octopress, Hello Hugo!](http://andreimihu.com/blog/2014/08/11/goodbye-octopress-hello-hugo/) | Andrei Mihu | 11 Aug 2014 |
24+
| [Beautiful sites for Open Source projects](http://beautifulopen.com/2014/08/09/hugo/) | Beautiful Open | 9 Aug 2014 |
25+
| [Hugo: Beyond the Defaults](http://npf.io/2014/08/hugo-beyond-the-defaults/) | Nate Finch | 8 Aug 2014 |
26+
| [First Impressions of Hugo](https://peteraba.com/blog/first-impressions-of-hugo/) | Peter Aba | 6 Aug 2014 |
27+
| [New Site Workflow](http://vurt.co.uk/post/new_website/) | Giles Paterson | 5 Aug 2014 |
28+
| [How I Learned to Stop Worrying and Love the (Static) Web](http://cognition.ca/post/about-hugo/) | Joshua McKenty | 4 Aug 2014 |
29+
| [Hugo over Octopress](http://kennywoo.com/blog/hugo---golang-based-static-site-generator/) | Kenny Woo | 3 Aug 2014 |
30+
| [Hugo Is Friggin' Awesome](http://npf.io/2014/08/hugo-is-awesome/) | Nate Finch | 1 Aug 2014 |
31+
| [Embedding Gists in Hugo](http://danmux.com/posts/embedded_gists/) | Dan Mull | 5 July 2014 |
32+
| [An Introduction To Hugo](http://www.cirrushosting.com/web-hosting-blog/an-introduction-to-hugo/) | Dan Silber | 1 July 2014 |
33+
| [Moving to Hugo](http://danmux.com/posts/hugo_based_blog/) | Dan Mull | 29 May 2014 |
34+
| [开源之静态站点生成器排行榜](http://code.csdn.net/news/2819909) | csdn.net | 23 May 2014 |
35+
| [How I deploy this site using Fabric](http://carlorat.me/quote/fabric/) | Carlo Ratam | 21 May 2014 |
36+
| [Finally, a satisfying and effective blog setup](http://michaelwhatcott.com/now-powered-by-hugo/) | Michael Whatcott | 20 May 2014 |
37+
| [Hugo from scratch](http://zackofalltrades.com/notes/2014/05/hugo-from-scratch/) | Zack Williams | 18 May 2014 |
38+
| [Why I switched away from Jekyll](http://www.jakejanuzelli.com/why-I-switched-away-from-jekyll/) | Jake Januzelli | 10 May 2014 |
39+
| [Welcome our new blog](http://blog.ninya.io/posts/welcome-our-new-blog/) | Ninya.io | 11 Apr 2014 |
40+
| [Mission Not Accomplished](http://johnsto.co.uk/blog/mission-not-accomplished/) | Dave Johnston | 3 Apr 2014 |
41+
| [Hugo - A Static Site Builder in Go](http://deepfriedcode.com/post/hugo/) | Deep Fried Code | 30 Mar 2014 |
42+
| [Adventures in Angular Podcast](http://devchat.tv/adventures-in-angular/003-aia-gdes) | Matias Niemela | 28 Mar 2014 |
43+
| [Hugo](http://bra.am/post/hugo/) | bra.am | 23 Mar 2014 |
44+
| [Converting Blogger To Markdown](http://trishagee.github.io/project/atom-to-hugo/) | Trisha Gee | 20 Mar 2014 |
45+
| [Moving to Hugo Static Web Pages](http://tepid.org/tech/hugo-web/) | Tobias Weingartner | 16 Mar 2014 |
46+
| [Hugo and Github Pages](http://sglyon.com/blog/2014/creating-the-site/) | Spencer Lyon | 15 Mar 2014 |
47+
| [New Blog Engine: Hugo](https://blog.afoolishmanifesto.com/posts/hugo/) | fREW Schmidt | 15 Mar 2014 |
48+
| [Hugo + gulp.js = Huggle](http://ktmud.github.io/huggle/intro/) | Jesse Yang | 8 Mar 2014 |
49+
| [Powered by Hugo](http://kieranhealy.org/blog/archives/2014/02/24/powered-by-hugo/) | Kieran Healy | 24 Feb 2014 |
50+
| [静的サイトを素早く構築するためにGoLangで作られたジェネレータHugo](http://hamasyou.com/blog/2014/02/21/hugo/) | Shogo Hamada | 21 Feb 2014 |
51+
| [Latest Roundup of Useful Tools For Developers](http://codegeekz.com/latest-roundup-of-useful-tools-for-developers/) | CodeGeekz | 13 Feb 2014 |
52+
| [Hugo: Static Site Generator written in Go](http://www.braveterry.com/2014/02/06/hugo-static-site-generator-written-in-go/) | Brave Terry | 6 Feb 2014 |
53+
| [10 Useful HTML5 Tools for Web Designers and Developers](http://designdizzy.com/10-useful-html5-tools-for-web-designers-and-developers/) | Design Dizzy | 4 Feb 2014 |
54+
| [Hugo – Fast, Flexible Static Site Generator](http://cube3x.com/hugo-fast-flexible-static-site-generator/) | Joby Joseph | 18 Jan 2014 |
55+
| [Hugo: A new way to build static website](http://www.w3update.com/opensource/hugo-a-new-way-to-build-static-website.html) | w3update | 17 Jan 2014 |
56+
| [Xaprb now uses Hugo](http://xaprb.com/blog/2014/01/15/using-hugo/) | Baron Schwartz | 15 Jan 2014 |
57+
| [New jQuery Plugins And Resources That Web Designers Need](http://www.designyourway.net/blog/resources/new-jquery-plugins-and-resources-that-web-designers-need/) | Design Your Way | 2014 |
58+
| [On Blog Construction](http://alexla.sh/post/on-blog-construction/) | Alexander Lash | 27 Dec 2013 |
59+
| [Hugo](http://onethingwell.org/post/69070926608/hugo) | One Thing Well | 5 Dec 2013 |
60+
| [In Praise Of Hugo](http://sound-guru.com/blog/post/hello-world/) | sound-guru.com | 19 Oct 2013 |
61+
| [Hosting a blog on S3 and Cloudfront](http://www.danesparza.net/2013/07/hosting-a-blog-on-s3-and-cloudfront/) | Dan Esparza | 24 July 2013 |
62+
63+
### Wrote a post, article or tutorial?
64+
65+
Have you written a post, article or tutorial on hugo? Send us a pull request or issue with the addition.

docs/content/meta/license.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
aliases:
3+
- /doc/license/
4+
- /license/
5+
- /meta/license/
6+
date: 2013-07-01
7+
menu:
8+
main:
9+
parent: about
10+
title: License
11+
weight: 50
12+
---
13+
14+
Hugo is released under the Simple Public License.
15+
16+
## Simple Public License (SimPL-2.0)
17+
18+
### Preamble
19+
20+
This Simple Public License 2.0 (SimPL-2.0 for short) is a plain language
21+
implementation of GPL 2.0. The words are different, but the goal is the
22+
same - to guarantee for all users the freedom to share and change
23+
software. If anyone wonders about the meaning of the SimPL, they should
24+
interpret it as consistent with GPL 2.0.
25+
26+
27+
## Simple Public License (SimPL) 2.0
28+
29+
The SimPL applies to the software's source and object code and comes
30+
with any rights that I have in it (other than trademarks). You agree to
31+
the SimPL by copying, distributing, or making a derivative work of the
32+
software.
33+
34+
You get the royalty free right to:
35+
36+
- Use the software for any purpose;
37+
- Make derivative works of it (this is called a "Derived Work");
38+
- Copy and distribute it and any Derived Work.
39+
40+
If you distribute the software or a Derived Work, you must give back to
41+
the community by:
42+
43+
- Prominently noting the date of any changes you make;
44+
- Leaving other people's copyright notices, warranty disclaimers, and
45+
license terms in place;
46+
- Providing the source code, build scripts, installation scripts, and
47+
interface definitions in a form that is easy to get and best to
48+
modify;
49+
- Licensing it to everyone under SimPL, or substantially similar terms
50+
(such as GPL 2.0), without adding further restrictions to the rights
51+
provided;
52+
- Conspicuously announcing that it is available under that license.
53+
54+
There are some things that you must shoulder:
55+
56+
- You get NO WARRANTIES. None of any kind;
57+
- If the software damages you in any way, you may only recover direct
58+
damages up to the amount you paid for it (that is zero if you did
59+
not pay anything). You may not recover any other damages, including
60+
those called "consequential damages." (The state or country where
61+
you live may not allow you to limit your liability in this way, so
62+
this may not apply to you);
63+
64+
The SimPL continues perpetually, except that your license rights end
65+
automatically if:
66+
67+
- You do not abide by the "give back to the community" terms (your
68+
licensees get to keep their rights if they abide);
69+
- Anyone prevents you from distributing the software under the terms
70+
of the SimPL.
71+
72+
## License for the License
73+
74+
You may do anything that you want with the SimPL text; it's a license
75+
form to use in any way that you find helpful. To avoid confusion,
76+
however, if you change the terms in any way then you may not call your
77+
license the Simple Public License or the SimPL (but feel free to
78+
acknowledge that your license is "based on the Simple Public License").

0 commit comments

Comments
 (0)