yaffs.net Git - yaffs-website/blob - web/themes/contrib/bootstrap/docs/README.md

   1 <!-- @file Documentation landing page and topics for the https://drupal-bootstrap.org site. -->
   2 <!-- @mainpage -->
   3 # Drupal Bootstrap Documentation
   4
   5 {.lead} The official documentation site for the [Drupal Bootstrap] base theme
   6
   7 The majority of this site is automatically generated from source files
   8 located through out the project's repository. Topics are extracted from Markdown
   9 files and the rest is extracted from embedded PHP comments.
  10
  11 ---
  12
  13 ## Topics
  14
  15 Below are some topics to help get you started using the [Drupal Bootstrap] base
  16 theme. They are ordered based on the level one typically progresses while using
  17 a base theme like this.
  18
  19 #### @link contributing Contributing @endlink
  20
  21 #### @link getting_started Getting Started @endlink
  22
  23 #### @link theme_settings Theme Settings @endlink
  24
  25 #### @link sub_theming Sub-Theming @endlink
  26 - @link sub_theming_cdn CDN Starterkit @endlink
  27 - @link sub_theming_less Less Starterkit @endlink
  28 - @link sub_theming_sass Sass Starterkit @endlink
  29
  30 #### @link templates Templates @endlink
  31
  32 #### @link utility Utilities @endlink
  33
  34 #### @link plugins Plugin System @endlink
  35 - @link plugins_alter @BootstrapAlter @endlink
  36 - @link plugins_form @BootstrapForm @endlink
  37 - @link plugins_preprocess @BootstrapPreprocess @endlink
  38 - @link plugins_prerender @BootstrapPrerender @endlink
  39 - @link plugins_process @BootstrapProcess @endlink
  40 - @link plugins_provider @BootstrapProvider @endlink
  41 - @link plugins_setting @BootstrapSetting @endlink
  42 - @link plugins_update @BootstrapUpdate @endlink
  43
  44 #### @link maintainers Project Maintainers @endlink
  45
  46 ---
  47
  48 ## Terminology
  49
  50 The term **"bootstrap"** can be used excessively through out this project's
  51 documentation. For clarity, we will always attempt to use this word verbosely
  52 in one of the following ways:
  53
  54 - **[Drupal Bootstrap]** refers to the Drupal base theme project.
  55 - **[Bootstrap Framework](https://getbootstrap.com/docs/3.3/)** refers to the external
  56   front end framework.
  57 - **[drupal_bootstrap](https://api.drupal.org/apis/drupal_bootstrap)** refers
  58   to Drupal's bootstrapping process or phase.
  59
  60 When referring to files inside the [Drupal Bootstrap] project directory, they
  61 will always start with `./bootstrap` and continue to specify the full path to
  62 the file or directory inside it. For example, the file that is responsible for
  63 displaying the text on this page is located at `./bootstrap/docs/README.md`.
  64
  65 When referring to files inside a sub-theme, they will always start with
  66 `./THEMENAME/`, where `THEMENAME` is the machine name of your sub-theme. They
  67 will continue to specify the full path to the file or directory inside it. For
  68 example, the primary file Drupal uses to determine if a theme
  69 exists is: `./THEMENAME/THEMENAME.info.yml`.
  70
  71 [Drupal Bootstrap]: https://www.drupal.org/project/bootstrap