diff --git a/templates/dash/generate-doc.html.twig b/templates/dash/generate-doc.html.twig deleted file mode 100644 index 196bbc715..000000000 --- a/templates/dash/generate-doc.html.twig +++ /dev/null @@ -1,56 +0,0 @@ - - - - - {% block title %}{{ command }}{% endblock %} - - - -

{{ command }}

-

The {{ command }} command: {{ description }}

-

Usage: - 

-        $ drupal {{ command }} {% if arguments|length>0 %}[arguments] {% endif %}{% if options|length>0 %}[options] {% endif %}
-
-

-{% if options|length>0 %} -

Available options

- - - - - - - - - {% for option in options %} - - - - - {% endfor %} - -
OptionDetails
{{ option.name }}{{ option.description }}
-{% endif %} - -{% if arguments|length>0 %} -

Available arguments

- - - - - - - - - {% for argument in arguments %} - - - - - {% endfor %} - -
ArgumentDetails
{{ argument.name }}{{ argument.description }}
-{% endif %} - - diff --git a/templates/dash/index.html.twig b/templates/dash/index.html.twig deleted file mode 100644 index 83428bd03..000000000 --- a/templates/dash/index.html.twig +++ /dev/null @@ -1,153 +0,0 @@ - - - - - Drupal Console - - - -

Drupal Console

- -

Getting the project

- -

There are different ways to get the project on your local machine. Our recommendation for getting the project on your - local machine is by using the installer.

- -

Using the Drupal Console Installer

- -

You can install the Drupal Console locally by running the installer in your project - directory, the installer will take care of downloading the necesary files to run drupal console on you computer. -

-

Using curl:

-
$ curl https://drupalconsole.com/installer -L -o drupal.phar
-
-

Or if you don't have curl:

-
php -r "readfile('https://drupalconsole.com/installer');" > drupal.phar
-
-

Example:

-
$ php console.phar generate:module
-
-

You can place this file anywhere you wish. If you put it in your PATH, you can access it - globally. On unixy systems you can even make it executable and invoke it without php. -

-

Access console from anywhere on your system

-
$ mv console.phar /usr/local/bin/drupal
-
-

Apply executable permissions on the downloaded file:

-
$ chmod +x /usr/local/bin/drupal
-
-

You can now execute console using:

-
$ drupal
-
-

NOTE: The name drupal is just an alias you can name it - anything you like. -

- -

Install Drupal Console Using Composer

- -

You can install this project using composer. - -

-
+
-
-

-

Install Drupal Console globally using composer:

-
$ composer global require drupal/console:@stable
-
-

Add the binary directory to your class path:

-
$ echo "PATH=$PATH:~/.composer/vendor/bin" >> ~/.bash_profile
-
-

You can now execute console using:

-
$ console generate:module
-
-

Download phar file

- -

You can download the latest version of Console from the repository releases page at:

- -

https://github.com/hechoendrupal/DrupalConsole -

- -

Make sure you download the console.phar file from the most current release.

- -

Update project

- -

Drupal 8 is under heavy development, to keep in sync with the latest changes. The easiest and recommended way of - updating Drupal Console is using the self-update command. -

-

Depending on the installation method:

-
Installed globally (and renamed to "drupal"):
-
$ drupal self-update
-
-
Installed globally (using composer):
-
$ composer global update drupal/console:@stable
-
-
Installed locally (running - from directory where the console.phar has been downloaded):
-
$ php console.phar self-update
-
-

Available Drupal Console Commands

-

Note: Drupal Console commands *must* be run from the root of a Drupal 8 installation.

- - - - - - - - - {% for namespace, commands in command_list %} - {% if namespace != 'none' %} - - - - - {% endif %} - {% for command in commands %} - - - - - {% endfor %} - {% endfor %} - -
Drupal Console CommandDetails
{{ namespace }}
{{ command.name }}{{ command.description }}
-{% if options|length>0 %} -

Available options

- - - - - - - - - {% for option in options %} - - - - - {% endfor %} - -
OptionDetails
{{ option.name }}{{ option.description }}
-{% endif %} -{% if arguments|length>0 %} -

Available arguments

- - - - - - - - - {% for argument in arguments %} - - - - - {% endfor %} - -
ArgumentDetails
{{ argument.name }}{{ argument.description }}
-{% endif %} - - diff --git a/templates/gitbook/available-commands-list.md.twig b/templates/gitbook/available-commands-list.md.twig deleted file mode 100644 index 3343a19aa..000000000 --- a/templates/gitbook/available-commands-list.md.twig +++ /dev/null @@ -1,14 +0,0 @@ -{% for namespace in application.namespaces %} -{% if not loop.first %} -{% set last_namespace = namespace %} -{% endif %} -{% if last_namespace is defined %} - - {# Empty new line hack #} -{% endif %} -{% spaceless %} -{% for command in commands[namespace] %} - * [{{ command.name }}](commands/{{ command.name|replace(':','-') }}.md) -{% endfor %} -{% endspaceless %} -{% endfor %} diff --git a/templates/gitbook/available-commands.md.twig b/templates/gitbook/available-commands.md.twig deleted file mode 100644 index a9791ba6b..000000000 --- a/templates/gitbook/available-commands.md.twig +++ /dev/null @@ -1,32 +0,0 @@ -# {{ application.messages.title }} - -**{{ application.messages.note }}:** {{ application.messages.note_description }}. - -{{ application.messages.command }} | {{ application.messages.details }} ------------- | ------------- -{% for namespace in application.namespaces %} -{% if namespace != 'none' %} -**{{ namespace }}** | -{% endif %} -{% for command in commands[namespace] %} -[{{ command.name }}]({{ command.name|replace(':','-') }}.md) | {{ command.description }} -{% endfor %} -{% endfor %} -{% if application.options|length>0 %} - -## {{ application.messages.options }} -{{ application.messages.option }} | {{ application.messages.details }} --------|------------- -{% for option in application.options %} ---{{ option.name }} | {{ option.description }} -{% endfor %} -{% endif %} -{% if application.arguments|length>0 %} - -## {{ application.messages.arguments }} -{{ application.messages.argument }} | {{ application.messages.details }} ----------|------------- -{% for argument in application.arguments %} -{{ argument.name }} | {{ argument.description }} -{% endfor %} -{% endif %} diff --git a/templates/gitbook/command.md.twig b/templates/gitbook/command.md.twig deleted file mode 100644 index df02d0900..000000000 --- a/templates/gitbook/command.md.twig +++ /dev/null @@ -1,39 +0,0 @@ -# {{ name }} -{{ description }} - -**{{ messages.usage }}:** -``` -$ drupal {{ name }}{% if arguments|length>0 %} [arguments]{% endif %}{% if options|length>0 %} [options]{% endif %} - -{% for alias in aliases %} -$ {{ alias }} -{% endfor %} -``` -{% if options|length>0 %} - -## {{ messages.options }} -{{ messages.option }} | {{ messages.details }} --------|------------- -{% for option in options %} ---{{ option.name }} | {{ option.description }} -{% endfor %} -{% endif %} -{% if arguments|length>0 %} - -## {{ messages.arguments }} -{{ messages.argument }} | {{ messages.details }} ----------|------------- -{% for argument in arguments %} -{{ argument.name }} | {{ argument.description }} -{% endfor %} -{% endif %} -{% if examples|length>0 %} - -## {{ messages.examples }} -{% for example in examples %} -* {{ example.description }} -``` -$ {{ example.execution }} -``` -{% endfor %} -{% endif %}