-
-
Notifications
You must be signed in to change notification settings - Fork 20
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
Showing
7 changed files
with
525 additions
and
11 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
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,206 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"> | ||
| <head> | ||
| <script> | ||
| // Hack for scrolling window when linking to anchor tag with fixed nav header | ||
| var shiftWindow = function() { scrollBy(0, -75) }; | ||
| window.addEventListener("hashchange", shiftWindow); | ||
| function load() { if (window.location.hash) shiftWindow(); } | ||
| </script> | ||
| <meta charset="utf-8"> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge"> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
|
|
||
|
|
||
| <link rel="canonical" href="https://njord.rs/get_started/"> | ||
| <link rel="shortcut icon" href="../img/favicon.ico"> | ||
| <title>GetStarted - njord - A lightweight ORM library for Rust with strong-typed SQL DSL and sequence APIs.</title> | ||
| <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous"> | ||
| <link href="../css/font-awesome.min.css" rel="stylesheet"> | ||
| <link href="../css/base.css" rel="stylesheet"> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css"> | ||
| <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> | ||
| <!--[if lt IE 9]> | ||
| <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script> | ||
| <script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script> | ||
| <![endif]--> | ||
|
|
||
| <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script> | ||
| <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/http.min.js"></script> | ||
| <script>hljs.initHighlightingOnLoad();</script> | ||
| <script src="../js/base.js"></script> | ||
| </head> | ||
|
|
||
| <body class=""> | ||
|
|
||
| <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> | ||
| <div class="container"> | ||
| <a class="navbar-brand" href="..">njord - A lightweight ORM library for Rust with strong-typed SQL DSL and sequence APIs.</a> | ||
| <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExample04" aria-controls="navbarsExample04" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <span class="navbar-toggler-icon"></span> | ||
| </button> | ||
|
|
||
| <div class="collapse navbar-collapse"> | ||
| <!-- Main navigation --> | ||
| <nav class="nav"> | ||
| <ul class="navbar-nav"> | ||
| <li > | ||
| <a class="nav-link" href="..">Home</a> | ||
| </li> | ||
| <li class="active"> | ||
| <a class="nav-link" href="./">GetStarted</a> | ||
| </li> | ||
| <li > | ||
| <a class="nav-link" href="../sqlite/">Sqlite</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
|
|
||
| <ul class="navbar-nav flex-row ml-md-auto d-none d-md-flex"> | ||
| <li class="nav-item"> | ||
| <a class="nav-link" href="#" data-toggle="modal" data-target="#mkdocs_search_modal"> | ||
| <i class="fa fa-search"></i> Search | ||
| </a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </nav><div id="content" class="container"> | ||
|
|
||
| <div class="row"> | ||
| <div class="col-md-9" role="main"> | ||
|
|
||
|
|
||
| <nav aria-label="breadcrumb"> | ||
| <ol class="breadcrumb"> | ||
|
|
||
| <li class="breadcrumb-item active" aria-current="page">GetStarted</li> | ||
| </ol> | ||
| </nav> | ||
|
|
||
|
|
||
| <h1 id="get-started">Get started</h1> | ||
| <p>To install njord into your Rust project we need to include the dependencies:</p> | ||
| <p><strong>Cargo.toml</strong></p> | ||
| <pre><code class="language-toml">[dependencies] | ||
|
|
||
| # The core APIs, including the Table trait. Always | ||
| # required when using njord. The "derive" feature is only required when | ||
| # using #[derive(Table)] to make njord work with structs | ||
| # and enums defined in your crate. | ||
| njord = { version = "0.1.0", features = ["derive"] } | ||
| </code></pre> | ||
|
|
||
| <ul class="metadata page-metadata" data-bi-name="page info" lang="en-us" dir="ltr"> | ||
| <li class="last-updated-holder displayDate loading"> | ||
| <span class="last-updated-text">Last updated:</span> | ||
| <time role="presentation" datetime="2018-10-25T00:00:00.000Z" data-article-date-source="ms.date"></time> | ||
| </li> | ||
| <!-- | ||
| <li class="readingTime"> | ||
| 2 minutes to read | ||
| </li> | ||
| --> | ||
| <li class="contributors-holder"> | ||
| <span class="contributors-text">Contributors</span> | ||
| <ul class="contributors" data-bi-name="contributors"></ul> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| <div class="col-md-3"><div class="navbar-light navbar-expand-md hidden-print sticky-top sticky-offset" role="complementary"> | ||
| <div class="navbar-header"> | ||
| <button type="button" class="navbar-toggler collapsed" data-toggle="collapse" data-target="#toc-collapse" title="Table of Contents"> | ||
| <span class="fa fa-angle-down"></span> | ||
| </button> | ||
| </div> | ||
|
|
||
| <div id="toc-collapse" class="navbar-collapse collapse card"> | ||
| <ul class="nav flex-column bs-sidenav"> | ||
| <li class="nav-item main"><a class="nav-link" href="#get-started">Get started</a></li> | ||
| </ul> | ||
| </div> | ||
| </div></div> | ||
| </div> | ||
| </div> | ||
|
|
||
| <footer class="col-md-12"> | ||
| <hr> | ||
| <div class="container"> | ||
| </div> | ||
| </footer> | ||
| <script> | ||
| var base_url = "..", | ||
| shortcuts = {"help": 191, "next": 78, "previous": 80, "search": 83}; | ||
| </script> | ||
| <script src="../js/base.js" defer></script> | ||
| <script src="../search/main.js" defer></script> | ||
|
|
||
| <div class="modal" id="mkdocs_search_modal" tabindex="-1" role="dialog" aria-labelledby="Search Modal" aria-hidden="true"> | ||
| <div class="modal-dialog modal-lg"> | ||
| <div class="modal-content"> | ||
| <div class="modal-header"> | ||
| <h4 class="modal-title">Search</h4> | ||
| <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button> | ||
| </div> | ||
| <div class="modal-body"> | ||
| <p> | ||
| From here you can search these documents. Enter | ||
| your search terms below. | ||
| </p> | ||
| <form role="form"> | ||
| <div class="form-group"> | ||
| <input type="text" class="form-control" placeholder="Search..." id="mkdocs-search-query" title="Type search term here"> | ||
| </div> | ||
| </form> | ||
| <div id="mkdocs-search-results"></div> | ||
| </div> | ||
| <div class="modal-footer"> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div><div class="modal" id="mkdocs_keyboard_modal" tabindex="-1" role="dialog" aria-labelledby="Keyboard Shortcuts Modal" aria-hidden="true"> | ||
| <div class="modal-dialog"> | ||
| <div class="modal-content"> | ||
| <div class="modal-header"> | ||
| <p class="h4 modal-title">Keyboard Shortcuts</p> | ||
| <button type="button" class="close" data-dismiss="modal"><span aria-hidden="true">×</span><span class="sr-only">Close</span></button> | ||
| </div> | ||
| <div class="modal-body"> | ||
| <table class="table"> | ||
| <thead> | ||
| <tr> | ||
| <th style="width: 20%;">Keys</th> | ||
| <th>Action</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr> | ||
| <td class="help shortcut"><kbd>?</kbd></td> | ||
| <td>Open this help</td> | ||
| </tr> | ||
| <tr> | ||
| <td class="next shortcut"><kbd>n</kbd></td> | ||
| <td>Next page</td> | ||
| </tr> | ||
| <tr> | ||
| <td class="prev shortcut"><kbd>p</kbd></td> | ||
| <td>Previous page</td> | ||
| </tr> | ||
| <tr> | ||
| <td class="search shortcut"><kbd>s</kbd></td> | ||
| <td>Search</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <div class="modal-footer"> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| </body> | ||
| </html> |
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
Oops, something went wrong.