Skip to main content

A sphinx theme for generate gotalk style presentation. #sphinxjp

Project description

Go talks style presentation theme for Sphinx.

travis coveralls.io latest version license requires.io

Features

  • Provide Go talks style theme for render presetation.
  • You don’t need to learn a special directive and role. All you have to know generally ReStructuredText.
  • Support PDF export.
  • Support Presenter notes.
  • Support OGP tags.

PDF Export

Presentations can be exported to PDF via a print stylesheet. This feature requires that you use Google Chrome or Chromium.

  1. Open your presentation.
  2. Open the in-browser print dialog (CMD+P).
  3. Change the Destination setting to Save as PDF.
  4. Click Save.

Presenter Notes

1. Embed notes

.. rst-class:: presenter-notes

  Lorem ipsum dolor sit amet, consectetur adipisicing elit,
  sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

2. Turrn on note_enabled in conf.py

html_theme_options  = {
   'note_enabled': True, # => default False.
}

This will allow you to open a second window by pressing ‘N’ from your browser displaying your slides. The second window is completely synced with your main window, except that presenter notes are only visible on the second window.

https://raw.githubusercontent.com/tell-k/sphinxjp.themes.gopher/master/docs/_static/img/presenter-notes.png

OGP Tags

You can add OGP settings in conf.py.

html_theme_options  = {
    # for canonical
    'canonical':'https://sphinxjpthemesgopher.readthedocs.io',

    # for title and "og:title" and "twitter:title"
    'ogp_title':'Sphinxjp.themes.gopher',

    # for "og:image" and "twitter:image"
    'ogp_image':'https://sphinxjpthemesgopher.readthedocs.io/_static/img/ogp.png',

    # for description and "og:description" and "twitter:description"
    'ogp_description':'A sphinx theme for generate gotalk style presentation. #sphinxjp',

    # for "og:url"
    'og_url':'https://sphinxjpthemesgopher.readthedocs.io',

    # for "og:site_name"
    'og_site_name':'readthedocs',

    # for "og:type"
    'og_type':'article',

    # for "article:author"
    'og_author':'https://github.com/tell-k',

    # for "twitter:card". default "summary"
    'twitter_card_type':'summary_large_image',

    # for "twitter:site"
    'twitter_card_site':'@tell_k',

    # for "twitter:creator"
    'twitter_card_creator':'@tell_k',
}

Caution

Set up

Make environment with pip:

$ pip install sphinxjp.themes.gopher

Convert Usage

setup conf.py with:

extensions = ['sphinxjp.themes.gopher']
html_theme = 'gopher'
html_use_index = False

and run:

$ make html

Requirement

  • Python 2.7 or later
  • Sphinx 1.3.x or later.

Using

License

See the src/LICENSE.txt file for specific terms.

AUTHORS

Sphinx template, css, packaging

  • tell-k <ffk2005 at gmail.com>

History

0.2.2 (Sep 25, 2018)

  • Fixed “Title slide” styles.

0.2.1 (Sep 22, 2018)

  • Add support for embedding canonical tags

0.2.0 (Sep 22, 2018)

  • Catch up with latest golang/tools static files.
  • Add support for display on mobile.
  • Add support for presenter notes.
  • Add support for OGP tag embedding.
  • Add Python 3.7 support.

0.1.1 (Mar 6, 2018)

0.1.0 (Nov 23, 2015)

  • First release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxjp.themes.gopher-0.2.2-py2.py3-none-any.whl (17.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3
sphinxjp.themes.gopher-0.2.2.tar.gz (608.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page