index.pug

doctype html
html(lang='en')
  head
    meta(charset='utf-8')
    meta(name="viewport", content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no")
    title Mongoose ODM v#{package.version}
    link(href="//fonts.googleapis.com/css?family=Anonymous+Pro:400,700|Droid+Sans+Mono|Open+Sans:400,700|Linden+Hill|Quattrocento:400,700|News+Cycle:400,700|Antic+Slab|Cabin+Condensed:400,700", rel="stylesheet", type="text/css")
    link(href="docs/css/default.css", rel="stylesheet")
    link(href="docs/css/style.css", rel="stylesheet")
    link(href="/docs/css/github.css", rel="stylesheet")

    link(rel='apple-touch-icon', sizes='57x57', href='docs/images/favicon/apple-icon-57x57.png')
    link(rel='apple-touch-icon', sizes='60x60', href='docs/images/favicon/apple-icon-60x60.png')
    link(rel='apple-touch-icon', sizes='72x72', href='docs/images/favicon/apple-icon-72x72.png')
    link(rel='apple-touch-icon', sizes='76x76', href='docs/images/favicon/apple-icon-76x76.png')
    link(rel='apple-touch-icon', sizes='114x114', href='docs/images/favicon/apple-icon-114x114.png')
    link(rel='apple-touch-icon', sizes='120x120', href='docs/images/favicon/apple-icon-120x120.png')
    link(rel='apple-touch-icon', sizes='144x144', href='docs/images/favicon/apple-icon-144x144.png')
    link(rel='apple-touch-icon', sizes='152x152', href='docs/images/favicon/apple-icon-152x152.png')
    link(rel='apple-touch-icon', sizes='180x180', href='docs/images/favicon/apple-icon-180x180.png')
    link(rel='icon', type='image/png', sizes='192x192',  href='docs/images/favicon/android-icon-192x192.png')
    link(rel='icon', type='image/png', sizes='32x32', href='docs/images/favicon/favicon-32x32.png')
    link(rel='icon', type='image/png', sizes='96x96', href='docs/images/favicon/favicon-96x96.png')
    link(rel='icon', type='image/png', sizes='16x16', href='docs/images/favicon/favicon-16x16.png')
    link(rel='manifest', href='docs/images/favicon/manifest.json')
    meta(name='msapplication-TileColor', content='#ffffff')
    meta(name='msapplication-TileImage', content='docs/images/favicon/ms-icon-144x144.png')
    meta(name='theme-color', content='#ffffff')

    style.
      code {
        font-size: 1em;
      }

      .sponsor {
        margin-bottom: 40px;
        font-size: 0.66em;
        color: #666;
        text-decoration: none;
      }

      .sponsors {
        margin-bottom: 40px;
      }

      .sponsors a {
        text-decoration: none;
      }

      .carbonad{
        margin-top:0!important;
        margin-bottom:-3rem!important
      }

      #carbonads {
        position:fixed;
        right: 0px;
        bottom: 0px;
        display:block;
        width:200px;
        padding:15px 15px 15px 160px;
        overflow:hidden;
        font-size:13px;
        line-height:1.4;
        text-align:left;
        background-color: #fafafa;
      }

      @media (max-width: 1160px) {
        #carbonads {
          display: none !important;
        }
      }

      #carbonads a{color:#333;text-decoration:none}

      .carbon-img{float:left;margin-left:-145px}

      .carbon-poweredby{display:block;color:#777!important}

      img.sponsor {
        margin-right: 10px;
        border: 1px dotted #dfdfdf;
        height: 100px;
      }

  body
    a#forkbanner(href="http://github.com/Automattic/mongoose")
      img(style="position: absolute; top: 0; right: 0; border: 0;", src="https://s3.amazonaws.com/github/ribbons/forkme_right_gray_6d6d6d.png", alt="Fork me on GitHub")
    #wrap.homepage
      #header
        h1
          a(href="https://github.com/Automattic/mongoose", target="blank")
            .mongoose Mongoose
      div.tagline
        :markdown
          Elegant [MongoDB](https://www.mongodb.com/) object modeling for
          [Node.js](https://nodejs.org/en/)
      #links
        ul
          li
            a(href="docs/guide.html") Read the Docs
          li
            a(href="https://plugins.mongoosejs.io") Discover Plugins
      #follow
        ul
          li
            iframe(class="github-btn", src="//ghbtns.com/github-btn.html?user=Automattic&repo=mongoose&type=watch&count=true", allowtransparency="true", frameborder="0", scrolling="0", width="100px", height="20px")
          li#version
            span
              | Version #{package.version}
          li
            iframe(class="github-btn", src="//ghbtns.com/github-btn.html?user=Automattic&repo=mongoose&type=fork&count=true", allowtransparency="true", frameborder="0", scrolling="0", width="100px", height="20px")
        
      #inner
        #what
          p.what
            | Let's face it, 
            strong writing MongoDB validation, casting and business logic boilerplate is a drag
            | . That's why we wrote Mongoose.
        :markdown
          ```javascript
          const mongoose = require('mongoose');
          mongoose.connect('mongodb://localhost:27017/test');

          const Cat = mongoose.model('Cat', { name: String });

          const kitty = new Cat({ name: 'Zildjian' });
          kitty.save().then(() => console.log('meow'));
          ```

          Mongoose provides a straight-forward, schema-based solution to model
          your application data. It includes built-in type casting, validation,
          query building, business logic hooks and more, out of the box.

        #tidelift.
          <a id="tidelift-button" href="https://tidelift.com/subscription/pkg/npm-mongoose?utm_source=npm-mongoose&utm_medium=website">
            <img src="/docs/images/tidelift.svg" />
            <span>Get Professionally Supported Mongoose</span>
          </a>

        div.carbon-ad
          <script async type="text/javascript" src="//cdn.carbonads.com/carbon.js?zoneid=1673&serve=C6AILKT&placement=mongoosejscom" id="_carbonads_js"></script>

        :markdown
          ## Getting Started

          * [quick start guide](/docs/index.html)

          ## Support

          * [Stack Overflow](http://stackoverflow.com/questions/tagged/mongoose)
          * [GitHub Issues](https://github.com/Automattic/mongoose/issues)
          * [Gitter Chat](https://gitter.im/Automattic/mongoose)
          * [MongoDB Support](http://www.mongodb.org/about/support/)

          ## News

          * [Twitter](https://twitter.com/mongoosejs)

          ## Changelog

          * [Changelog](https://github.com/Automattic/mongoose/blob/master/CHANGELOG.md)

          ## GitHub Sponsors

          <div class="sponsors">
            <div>
              <a rel="sponsored" href="https://localizejs.com/">
                <img class="sponsor" src="//images.ctfassets.net/3ouphkrynjol/3mfb7HH2YowrPxX9C6ik6H/723034bcb4e99349663c4bc8223fb8b6/localizejs.com.png" style="height: 100px">
              </a>
              <a rel="sponsored" href="https://birb.app/">
                <img class="sponsor" src="https://uploads-ssl.webflow.com/618b15b23212e0b2b4f8f67b/618b189f1d441fd9e0f6c5f3_logo-black-text.png" style="height: 100px">
              </a>
              <a rel="sponsored" href="https://helloclub.com/?source=Mongoose">
                <img class="sponsor" src="https://helloclub.com/images/logo/logo-text-white.svg" style="height:100px">
              </a>
            </div>
          </div>

          ## Sponsors

        div.sponsors
          div
            each sponsor in opencollectiveSponsors
              a(rel='sponsored', href=sponsor.website, alt=sponsor.alt)
                img.sponsor(src=sponsor.image || null, style='height:50px')

        <div class="sponsor">
          Sponsor <a href="https://opencollective.com/mongoose">Mongoose on OpenCollective</a>
          to get your company's logo above!
        </div>

    p#footer Licensed under MIT.
    script.
      document.body.className = 'load';
    include docs/includes/track