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
bcf47d6c
Commit
bcf47d6c
authored
Dec 07, 2014
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add documentation on how to contribute to the docs.
parent
84fd21b3
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
with
67 additions
and
2 deletions
+67
-2
Gruntfile.js
Gruntfile.js
+1
-1
docs/source/development.rst
docs/source/development.rst
+1
-1
docs/source/documentation.rst
docs/source/documentation.rst
+58
-0
docs/source/index.rst
docs/source/index.rst
+7
-0
No files found.
Gruntfile.js
View file @
bcf47d6c
...
@@ -112,7 +112,7 @@ module.exports = function(grunt) {
...
@@ -112,7 +112,7 @@ module.exports = function(grunt) {
// 'r.js -o src/build.js paths.converse-dependencies=src/deps-no-otr paths.locales=locale/nolocales out=builds/converse-no-locales-no-otr.min.js'
// 'r.js -o src/build.js paths.converse-dependencies=src/deps-no-otr paths.locales=locale/nolocales out=builds/converse-no-locales-no-otr.min.js'
});
});
grunt
.
registerTask
(
'
minify
'
,
'
Create a new
release
'
,
[
'
cssmin
'
,
'
jsmin
'
]);
grunt
.
registerTask
(
'
minify
'
,
'
Create a new
minified builds
'
,
[
'
cssmin
'
,
'
jsmin
'
]);
grunt
.
registerTask
(
'
check
'
,
'
Perform all checks (e.g. before releasing)
'
,
function
()
{
grunt
.
registerTask
(
'
check
'
,
'
Perform all checks (e.g. before releasing)
'
,
function
()
{
grunt
.
task
.
run
(
'
jshint
'
,
'
test
'
);
grunt
.
task
.
run
(
'
jshint
'
,
'
test
'
);
...
...
docs/source/development.rst
View file @
bcf47d6c
...
@@ -3,7 +3,7 @@ Development
...
@@ -3,7 +3,7 @@ Development
===========
===========
.. contents:: Table of Contents
.. contents:: Table of Contents
:depth:
3
:depth:
2
:local:
:local:
If you want to work with the non-minified Javascript and CSS files you'll soon
If you want to work with the non-minified Javascript and CSS files you'll soon
...
...
docs/source/documentation.rst
0 → 100644
View file @
bcf47d6c
=====================
Writing Documentation
=====================
.. contents:: Table of Contents
:depth: 2
:local:
.. note:: Contributions to the documentation are much appreciated.
What is used to write the documentation
=======================================
This documentation is written in `Sphinx <http://sphinx-doc.org/>`_, a
documentation generator written in `Python <http://python.org>`_.
The documentation is written in `reStructuredText (reST) <http://sphinx-doc.org/rest.html>`_,
a very easy to write plain text format, relatively similar to Markdown.
So see what the source looks like, click the **Source** link in the footer of
this page.
Where is the documentation
==========================
The reST documentation files are located in the
`converse.js code repository <https://github.com/jcbrand/converse.js/tree/master/docs/source>`_
under ``docs/source``.
How to generate HTML from the source files
==========================================
Install Dependencies
--------------------
In order to generate HTML from the source files, you need to have Sphinx and
the `Sphinx Bootstrap Theme <http://ryan-roemer.github.io/sphinx-bootstrap-theme>`_
installed.
We use `zc.buildout <http://www.buildout.org/en/latest/>`_ to install Sphinx
and the theme.
To install Sphinx, do the following::
python bootstrap.py
./bin/buildout
Generate the HTML
-----------------
After installing the dependencies, you can generate the HTML by simply
running::
make html
The HTMl files will be located in ``./docs/html``
.. warning:: When contributing, please don't commit any generated html files.
docs/source/index.rst
View file @
bcf47d6c
...
@@ -10,6 +10,12 @@ Converse.js Documentation
...
@@ -10,6 +10,12 @@ Converse.js Documentation
Preface
Preface
=======
=======
This is the official documentation for Converse.js. If you'd like to
contribute, please read the :doc:`documentation` page.
Introduction
============
Converse.js is a free and open-source `XMPP <http://xmpp.org/about-xmpp/>`_
Converse.js is a free and open-source `XMPP <http://xmpp.org/about-xmpp/>`_
chat client written in Javascript which can be tightly integrated into any website.
chat client written in Javascript which can be tightly integrated into any website.
...
@@ -37,4 +43,5 @@ Table of Contents
...
@@ -37,4 +43,5 @@ Table of Contents
configuration
configuration
development
development
translations
translations
documentation
builds
builds
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