Giter Club home page Giter Club logo

rapidjs.io's Introduction

rapidjs.io - The docs for rapid.js

Getting a working local environment

npm install

Valet (mac users only)

  • Install valet
  • valet link rapid

Understanding The File Structure

This is a Laravel build. If you're not familiar with it, give it a look! There's quite a few folders in this install but below are the only ones to be concerned with.

data/ - This contains the data for all the methods and configuration that are displayed on the docs page. This also contains the data that tells the docs what pages to render per section.

resources/ - The views and assets.

      |---views/ - The view template files.

            |---documentation/ -This is where the main documentation files live. For each section of the docs, a folder with sub pages lives.

                  |---methods & configuration - Each one if these has a code folder where, if a file is created, it will be displayed below its definition on the docs page.

      |---assets/ - The js.

            |---sass/ -The sass

            |---js/ -The JS for minor things such as code formatting and the config builder. Not really necessary to edit.

Linting Your Sass

If you make any changes to the sass you must follow the guidelines in the scsslint.yml. If you're not familiar with this, have a look here. Please follow the BEM syntax as I am loosley following it. Running the gulp lint-sass command should have no errors before commiting.

gulp lint-sass

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.