xmpp.chapril.org-conversejs/docs/source/builds.rst

.. raw:: html

    <div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/builds.rst">Edit me on GitHub</a></div>


.. _builds:

===============
Creating builds
===============

.. contents:: Table of Contents
   :depth: 3
   :local:


.. warning:: There current documentation in this section does not adequately
    explain how to create custom builds.

.. note:: Please make sure to read the section :doc:`development` and that you have installed
    all development dependencies (long story short, you should be able to just run  ``make dev``)

Creating builds and distribution files
======================================

We  use `require.js <http://requirejs.org>`_ to keep track of *Converse.js* and
its dependencies and to to bundle them together in a single file fit for
deployment to a production site.

To create the distributable bundles, simply run::

    make dist

This command does the following:

* It creates different Javascript bundles of Converse.js.
  The individual javascript files will be bundled and minified with `require.js`_'s
  optimization tool, using `almond <https://github.com/jrburke/almond>`_.
  You can `read more about require.js's optimizer here <http://requirejs.org/docs/optimization.html>`_.

* It bundles the HTML templates in ``./src/templates/`` into a single file called ``templates.js``.
  This file can then be included via the ``<script>`` tag. See for example the ``non_amd.html`` example page.

* It bundles all the translation files in ``./locale/`` into a single file ``locales.js``.
  This file can then be included via the ``<script>`` tag. See for example the ``non_amd.html`` example page.

* Also, the CSS files in the ``./css`` directory will be minified.

The built Javasript bundles are contained in the ``./dist`` directory:

.. code-block:: bash

    jc@conversejs:~/converse.js (master)$ ls dist/
    converse.js               converse-no-dependencies.js      
    converse.min.js           converse-no-dependencies.min.js  
    converse.nojquery.js      locales.js
    converse.nojquery.min.js  templates.js

.. _`minification`:

Minifying the CSS
-----------------

To only minify the CSS files, nothing else, run the following command::

    make cssmin

The CSS files  are minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
Add an "Edit me on Github" ribbon to the docs 2015-05-02 01:21:25 +02:00			`.. raw:: html`

			`<div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/builds.rst">Edit me on GitHub</a></div>`


Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			`.. _builds:`

			`===============`
			`Creating builds`
			`===============`
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
			`.. contents:: Table of Contents`
			`:depth: 3`
			`:local:`


			`.. warning:: There current documentation in this section does not adequately`
			`explain how to create custom builds.`

Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			.. note:: Please make sure to read the section :doc:`development` and that you have installed
			all development dependencies (long story short, you should be able to just run ``make dev``)

Rename builds directory to dist To conform with how many other projects name their directories. 2016-02-28 10:00:22 +01:00			`Creating builds and distribution files`
			`======================================`
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00
			We use `require.js <http://requirejs.org>`_ to keep track of Converse.js and
			`its dependencies and to to bundle them together in a single file fit for`
			`deployment to a production site.`

Rename builds directory to dist To conform with how many other projects name their directories. 2016-02-28 10:00:22 +01:00			`To create the distributable bundles, simply run::`
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00
Rename builds directory to dist To conform with how many other projects name their directories. 2016-02-28 10:00:22 +01:00			`make dist`
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			`This command does the following:`
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			`* It creates different Javascript bundles of Converse.js.`
			The individual javascript files will be bundled and minified with `require.js`_'s
			optimization tool, using `almond <https://github.com/jrburke/almond>`_.
			You can `read more about require.js's optimizer here <http://requirejs.org/docs/optimization.html>`_.
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			* It bundles the HTML templates in ``./src/templates/`` into a single file called ``templates.js``.
			This file can then be included via the ``<script>`` tag. See for example the ``non_amd.html`` example page.
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			* It bundles all the translation files in ``./locale/`` into a single file ``locales.js``.
			This file can then be included via the ``<script>`` tag. See for example the ``non_amd.html`` example page.
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			* Also, the CSS files in the ``./css`` directory will be minified.

Rename builds directory to dist To conform with how many other projects name their directories. 2016-02-28 10:00:22 +01:00			The built Javasript bundles are contained in the ``./dist`` directory:
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00
			`.. code-block:: bash`

Rename builds directory to dist To conform with how many other projects name their directories. 2016-02-28 10:00:22 +01:00			`jc@conversejs:~/converse.js (master)$ ls dist/`
			`converse.js converse-no-dependencies.js`
			`converse.min.js converse-no-dependencies.min.js`
			`converse.nojquery.js locales.js`
			`converse.nojquery.min.js templates.js`
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00
			.. _`minification`:
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			`Minifying the CSS`
			`-----------------`
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			`To only minify the CSS files, nothing else, run the following command::`
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			`make cssmin`
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00
Add theming documentation and extend the docs on creating builds. 2015-02-05 15:58:51 +01:00			The CSS files are minified via `cssmin <https://github.com/gruntjs/grunt-contrib-cssmin>`_.
Split the documentation out into subfiles. 2014-12-07 00:53:17 +01:00