Giter VIP home page Giter VIP logo

mdb-docs-and-content's Introduction

mdb-docs-and-content

The following repository contains content of the mdbootstrap.com website, especially documentation.

Within the root folder you can find two main languages - English and Chineese (simplified) (to be translated).

Next level defines technology (jQuery, Angular, React and Vue). 3rd level defines platform - web or mobile (note: currently MDB is available as a web development framework, we are builing a Native version of MDB dedicated to mobile apps).

4th defines documenation type (documentation/tutorial etc.), currently only docs are available at GitHub. In a future we will move also other content.

Finally 5th and 6th level defines categories and specific components. Please note that the folder structure corresponds with URL i.e.:

https://mdbootstrap.com/docs/jquery/css/text-color/

Can be found under /en/jquery/web/docs/css/text-color/ (https://github.com/mdbootstrap/mdb-docs-and-content/tree/master/en/jquery/web/docs/css/text-color )

Each folder contains multiple files:

  • o.html (Content of the overview TAB)
  • o-ss.html (Content of the scrollspy for Overview TAB)
  • gs.html (Content of the Getting started TAB)
  • gs-ss.html (Content of the scrollspy for Getting started TAB)
  • a.html (Content of the API TAB)
  • a-ss.html ((Content of the scrollspy for API TAB)
  • js.html (Specific JavaScript code imported at the bottom if needed for demo)

So how YOU can contribute to ever growing MDB repo? It is easier than you may think.

First you have to click “Edit these docs” button placed on top of MDB component’s page of your choosing.

Thanks to modern day magic known as a link you will jump to GitHub repository that contains designated documentation.

Now you have to click “Fork” button to copy it to your GitHub account.

After a few seconds, you should have your own version of the source file to play with. So click on the filename of documentation and then click on the pencil icon on the right.

Here it is where all the fun begins. You can freely input your insight and code snippets.

To finish your adjustments you must provide commit name and description. Make sure that you also provide the name of a new branch containing your changes.

Press “Propose file change” button, and then “Create pull request” button, finally allowing us to admire your genius and after positive verification letting you to bask in well deserved glory as a top tier programmer and code visionary.

mdb-docs-and-content's People

Contributors

aandrasiuk avatar agentsmith0 avatar ascensus-mdb avatar bloodcast69 avatar caarek avatar catchmareck avatar dawidadach avatar filipkappa avatar gbujanski avatar iceberg1109 avatar idzark avatar ingoldsby avatar jacekok avatar jakubchmura avatar kordrad avatar kpietron avatar krzysiu-w avatar makusref avatar marlucz avatar martussky avatar marveluck avatar mattonit avatar mwiniarski01 avatar pglejzer avatar piotrobrebski avatar razkaroth avatar smolenski-mikolaj avatar vladviolentiy avatar wojstan avatar wolfgangmetze 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.