Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
4f72b099
Commit
4f72b099
authored
Oct 26, 2018
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Mention creating your own builds in the quickstart guide
parent
78914867
Changes
2
Show whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
24 additions
and
4 deletions
+24
-4
docs/source/builds.rst
docs/source/builds.rst
+3
-2
docs/source/quickstart.rst
docs/source/quickstart.rst
+21
-2
No files found.
docs/source/builds.rst
View file @
4f72b099
...
...
@@ -20,6 +20,8 @@ Generating 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:
Creating JavaScript and CSS bundles and distribution files
==========================================================
...
...
@@ -43,9 +45,8 @@ to let the bundles be automatically generated as soon as you edit a file.
The Converse repository does not include the minified files in the ``dist`` or
``css`` directories. Before deployment, you'll want to generate them yourself.
To only generate the minified files, you can make them individually.
To only generate the minified files, you can make them individually.
::
::
make dist/converse.min.js
make css/converse.min.css
...
...
docs/source/quickstart.rst
View file @
4f72b099
...
...
@@ -9,8 +9,8 @@ Quickstart
Getting a demo up and running
=============================
Use the content delivery network
--------------------------------
Option 1:
Use the content delivery network
--------------------------------
----------
Converse has a `CDN <https://en.wikipedia.org/wiki/Content_delivery_network>`_, provided by `KeyCDN <http://keycdn.com/>`_,
which hosts its JavaScript and CSS files.
...
...
@@ -42,6 +42,25 @@ via the *script* and *link* tags:
latest one), to avoid breakage when new backwards-incompatible versions are
released.
Option 2: Building the files yourself
-------------------------------------
Instead of using the CDN, you can also create your own builds and host them
yourself.
Have a look at the :ref:`creating_builds` section on how to create your own
builds.
Long story short, you should be able to do it by running `make dist`, but you
might need to install some development libraries on your system first
(e.g. gcc, libffi-dev and ruby-dev).
Besides including the ``converse.min.js`` and ``converse.min.css`` files,
you'll also need to make sure that the ``webfonts`` directory is available in
the same location as ``converse.min.css``.
Initializing Converse
---------------------
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment