Giter Club home page Giter Club logo

mongokittendocumentation's Introduction

MongoDB Swift Driver Documentation

Quick Start

  1. Install hugo
  2. Create ./data/mongodb.toml
  3. Create content

Requirements

Hugo version 0.18 (brew install hugo)
Check out the hugo quickstart guide.

Running the server

To run the server call the hugo command:

hugo server --baseUrl=http://localhost/ --buildDrafts --watch
Options explained
server Hugo runs its own webserver to render the files
--baseUrl=http://localhost/ Normally the base url will be /mongo-java-driver for gh-pages
--buildDrafts Include draft posts in the output - these won't be published to gh-pages
-- watch Automatically reloads on file change

All generated content will appear in the ./public folder, so you can also check the filesystem and browse it locally.
For more hugo server options run: hugo --help

Generate the website

hugo -d docs

Data

You should create ./data/mongodb.toml and copy the themes/mongodb/data/mongodb.toml file and set the values as needed.

Creating new content

Handy markdown cheat sheet will help with markdown issues and in markdown you can fall back to html if needed.

To create new content run: hugo new <contentFileName>.md and the new file will created in the ./content directory and marked as a draft.

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

Menus

Menu configuration generally goes in the content front matter. See the hugo menu docs, menus can also be configured in the top level config.toml.

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).

MongoDB Theme

Do not delete / change anything in themes.
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.

You shouldn't edit the mongodb theme directly this will eventually be removed and live in its own repo for ease of sharing.

mongokittendocumentation's People

Contributors

lgaches avatar joannis avatar

Watchers

James Cloos avatar Tanner avatar Andrew Edwards avatar

Forkers

akeskiner

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.