Skip to content

Commit

Permalink
start the documentation for Radix 4
Browse files Browse the repository at this point in the history
  • Loading branch information
shadcn committed Mar 25, 2019
1 parent de73669 commit c8bf2c5
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 11 deletions.
17 changes: 11 additions & 6 deletions docs/index.md
@@ -1,13 +1,12 @@
Radix is a base theme for [Drupal](http://drupal.org) and [Backdrop CMS](http://backdropcms.org).
It has **Bootstrap**, **Sass**, **Gulp**, **Bower**, **BrowserSync** and **Font Awesome** built-in.
It has **Bootstrap**, **Sass**, **BrowserSync** and **Font Awesome** built-in.

# Features

* Components and plugins from Bootstrap.
* Responsive Panels with Radix Layouts.
* Sass, Gulp, BrowserSync and Font Awesome built-in.
* Drush intergration: drush radix "My Subtheme".
* Works with Bootswatch themes: drush radix "My Subtheme" --bootswatch=cerulean".
* Components and plugins from Bootstrap
* Responsive layouts with Radix Layouts
* Sass, BrowserSync and Font Awesome built-in
* Drush integration: `drush radix "My Subtheme"`

# Distributions using Radix

Expand All @@ -22,3 +21,9 @@ It has **Bootstrap**, **Sass**, **Gulp**, **Bower**, **BrowserSync** and **Font

**[Open Restaurant](http://open.restaurant)**
- The Open Restaurant distribution has everything you need to kickstart your restaurant website. It comes with a menu management system, a reservation system, a customizable blog and events management.

**[DKAN Open Data Platform](https://getdkan.org/)**
-DKAN is a community-driven, free and open source open data platform that gives organizations and individuals ultimate freedom to publish and consume structured information.

**[University of IOWA SiteNow](https://sitenow.uiowa.edu/)**
-SiteNow provides flexibility in authoring websites for various audiences.
8 changes: 6 additions & 2 deletions docs/drupal.md → docs/radix-3.md
@@ -1,6 +1,10 @@
Documentation for the Radix theme for Drupal.
# Radix 4.x
Documentation for Radix 3.x for Drupal.

# Requirements
!!! Tip
Starting a new project?. Consider [Radix 4.x](/radix-4) with **Bootstrap 4**.

## Requirements

1. [npm](https://www.npmjs.com) - [Read a guide on how to install Node and npm here](https://docs.npmjs.com/getting-started/installing-node).
2. [Gulp](http://gulpjs.com) - `npm install gulp -g`
Expand Down
29 changes: 29 additions & 0 deletions docs/radix-4.md
@@ -0,0 +1,29 @@
# Radix 4.x
Documentation for Radix 4.x theme for Drupal 8.

## Requirements

1. [npm](https://www.npmjs.com) - [Read a guide on how to install Node and npm here](https://docs.npmjs.com/getting-started/installing-node).
2. [Drush](http://drush.org) - [Read a guide on how to install Drush here](http://www.drush.org/en/master/install/).
3. [Components module](https://www.drupal.org/project/components)

## Quick start for Drupal 8

1. Download and enable radix: `drush dl radix; drush en radix -y;`.
2. Create a subtheme: `drush radix "SUBTHEME NAME"`.
3. Set default theme: `drush en SUBTHEME_NAME -y; drush config-set system.theme default SUBTHEME_NAME -y`.
4. Install required modules: `cd /path/to/SUBTHEME_NAME; npm install;`.
5. Update proxy in `/path/to/SUBTHEME_NAME/webpack.mix.js`.
6. Watch: `npm run watch`.

## Using Composer
Use the following command to install Radix using composer. This will pull in Radix and the Components module.

```
composer require drupal/radix
```

# Support

1. Create an issue on [drupal.org](https://www.drupal.org/project/issues/radix).
2. Ask us on Twitter: [@radixtheme](http://twitter.com/radixtheme).
9 changes: 6 additions & 3 deletions mkdocs.yml
Expand Up @@ -3,6 +3,9 @@ theme: readthedocs
repo_url: https://github.com/radixtheme/docs
include_search: true
pages:
- Home: index.md
- Drupal: drupal.md
- Backdrop: backdrop.md
- Home: index.md
- Radix 4.x: radix-4.md
- Radix 3.x: radix-3.md
- Backdrop: backdrop.md
markdown_extensions:
- admonition

0 comments on commit c8bf2c5

Please sign in to comment.