upstream/kallithea Files · docs/usage/customization.rst

tests: fix vcs Hg helper function get_config_value to not modify global state when using a custom config file...

tests: fix vcs Hg helper function get_config_value to not modify global state when using a custom config file This leak was what made test_get_user_name and test_get_user_email pass when test_get_config_value had been run first.

domruf - - Load All Authors

File last commit:

r7174:8152f9e6 default


                r7307:e885a8ef

default

Download file

             customization.rst
        
                    73 lines
            
             | 2.5 KiB
            
                | text/x-rst
            
             |
                RstLexer
            
             / docs / usage / customization.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Thomas De Schampheleire
    
docs: document Kallithea customization options...

              r5746
            
      .. _customization:

      =============

      Customization

      =============

      There are several ways to customize Kallithea to your needs depending on what

      you want to achieve.

      HTML/JavaScript/CSS customization

      ---------------------------------

      To customize the look-and-feel of the web interface (for example to add a

      company banner or some JavaScript widget or to tweak the CSS style definitions)

      you can enter HTML code (possibly with JavaScript and/or CSS) directly via the

      *Admin > Settings > Global > HTML/JavaScript customization

      block*.

        domruf
    
less: load optional theme.less file to allow custom styles...

              r7174
            
      Style sheet customization with Less

      -----------------------------------

      Kallithea uses `Bootstrap 3`_ and Less_ for its style definitions. If you want

      to make some customizations, we recommend to do so by creating a ``theme.less``

      file. When you create a file named ``theme.less`` in the Kallithea root

      directory, you can use this file to override the default style. For example,

      you can use this to override ``@kallithea-theme-main-color``,

      ``@kallithea-logo-url`` or other `Bootstrap variables`_.

      After creating the ``theme.less`` file, you need to regenerate the CSS files.

      Install npm for your platform and run::

          npm install

          npm run less

      in the Kallithea root directory.

      .. _bootstrap 3: https://getbootstrap.com/docs/3.3/

      .. _bootstrap variables: https://getbootstrap.com/docs/3.3/customize/#less-variables

      .. _less: http://lesscss.org/

        Thomas De Schampheleire
    
docs: document Kallithea customization options...

              r5746
            
      Behavioral customization: rcextensions

      --------------------------------------

      Some behavioral customization can be done in Python using ``rcextensions``, a

      custom Python package that can extend Kallithea functionality.

      With ``rcextensions`` it's possible to add additional mappings for Whoosh

      indexing and statistics, to add additional code into the push/pull/create/delete

      repository hooks (for example to send signals to build bots such as Jenkins) and

      even to monkey-patch certain parts of the Kallithea source code (for example

      overwrite an entire function, change a global variable, ...).

      To generate a skeleton extensions package, run::

        Mads Kiilerich
    
gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack...

              r6509
            
          gearbox make-rcext -c my.ini

        Thomas De Schampheleire
    
docs: document Kallithea customization options...

              r5746
            
      This will create an ``rcextensions`` package next to the specified ``ini`` file.

      See the ``__init__.py`` file inside the generated ``rcextensions`` package

      for more details.

      Behavioral customization: code changes

      --------------------------------------

      As Kallithea is open-source software, you can make any changes you like directly

      in the source code.

      We encourage you to send generic improvements back to the

      community so that Kallithea can become better. See :ref:`contributing` for more

      details.

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Thomas De Schampheleire docs: document Kallithea customization options...	r5746	.. _customization:

		=============
		Customization
		=============

		There are several ways to customize Kallithea to your needs depending on what
		you want to achieve.


		HTML/JavaScript/CSS customization
		---------------------------------

		To customize the look-and-feel of the web interface (for example to add a
		company banner or some JavaScript widget or to tweak the CSS style definitions)
		you can enter HTML code (possibly with JavaScript and/or CSS) directly via the
		*Admin > Settings > Global > HTML/JavaScript customization
		block*.


domruf less: load optional theme.less file to allow custom styles...	r7174	Style sheet customization with Less
		-----------------------------------

		Kallithea uses `Bootstrap 3`_ and Less_ for its style definitions. If you want
		to make some customizations, we recommend to do so by creating a ``theme.less``
		file. When you create a file named ``theme.less`` in the Kallithea root
		directory, you can use this file to override the default style. For example,
		you can use this to override ``@kallithea-theme-main-color``,
		``@kallithea-logo-url`` or other `Bootstrap variables`_.

		After creating the ``theme.less`` file, you need to regenerate the CSS files.
		Install npm for your platform and run::

		npm install
		npm run less

		in the Kallithea root directory.

		.. _bootstrap 3: https://getbootstrap.com/docs/3.3/
		.. _bootstrap variables: https://getbootstrap.com/docs/3.3/customize/#less-variables
		.. _less: http://lesscss.org/


Thomas De Schampheleire docs: document Kallithea customization options...	r5746	Behavioral customization: rcextensions
		--------------------------------------

		Some behavioral customization can be done in Python using ``rcextensions``, a
		custom Python package that can extend Kallithea functionality.

		With ``rcextensions`` it's possible to add additional mappings for Whoosh
		indexing and statistics, to add additional code into the push/pull/create/delete
		repository hooks (for example to send signals to build bots such as Jenkins) and
		even to monkey-patch certain parts of the Kallithea source code (for example
		overwrite an entire function, change a global variable, ...).

		To generate a skeleton extensions package, run::

Mads Kiilerich gearbox: replace paster with something TurboGears2-ish that still works with the Pylons stack...	r6509	gearbox make-rcext -c my.ini
Thomas De Schampheleire docs: document Kallithea customization options...	r5746
		This will create an ``rcextensions`` package next to the specified ``ini`` file.
		See the ``__init__.py`` file inside the generated ``rcextensions`` package
		for more details.


		Behavioral customization: code changes
		--------------------------------------

		As Kallithea is open-source software, you can make any changes you like directly
		in the source code.

		We encourage you to send generic improvements back to the
		community so that Kallithea can become better. See :ref:`contributing` for more
		details.