Code Monkey home page Code Monkey logo

cars-sg's Introduction

Cars.com Core Styleguide

The Cars.com styleguide is a single page app, running CanJS. Being an FE-only single page application ensure that no application logic is required for style and module documentation.

The app framework leverages JSON and Markdown files for documentation. The code samples themselves are used to generate the actual output, and all references in the main.js file powering the app should tie directly to libraries and modules in the current branch. Doing so ensures that the current (documented) codebase is functional in parallel with any other code changes that will be propogated.

The styleguide layout is as follows:

|-- core
    |-- styleguide
        |-- css
            |-- theme.css              (styleguide-specific styles)
        |-- data
            |-- styleguide.nav.json    (stylguide navigation data -- left rail)
            |-- pages
                |-- {pagename.json}    (page definition -- documentation hooks)
        |-- examples                   (styleguide example documentation)
            |-- {folder}               (documentation categorization)
            |-- {name.markdown}        (styleguide topic documentation)
        |-- js                         (styleguide-specific javascript)
            |-- main.js
            |-- app.js
            |-- libs                   (styleguide-specific libraries)
        |-- templates                  (styleguide-specific templates -- ejs)
        |-- index.html                 (single page application -- includes core.css)
        |-- readme.md                  (application doc)

cars-sg's People

Contributors

edeviant avatar

Watchers

Nate Johnson avatar  avatar

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.