landslideダウンロード - landslideソースコードのダウンロード

landslide

その他のソースコード

1.0.0

ダウンロード

地滑り

Landslide は、マークダウン、ReST、またはテキスタイルを使用してスライドショーを生成します。これは、Google の html5slides テンプレートから構築されています。

次のマークダウンにより、このスライドショーが作成されます。

 # Landslide

---

# Overview

Generate HTML5 slideshows from markdown, ReST, or textile.

![python](http://i.imgur.com/bc2xk.png)

Landslide is primarily written in Python, but it's themes use:

- HTML5
- Javascript
- CSS

---

# Code Sample

Landslide supports code snippets

    !python
    def log(self, message, level='notice'):
        if self.logger and not callable(self.logger):
            raise ValueError(u"Invalid logger set, must be a callable")

        if self.verbose and self.logger:
            self.logger(message, level)

要件

pythonと次のモジュール:

jinja2
コードブロック構文の色付け用のpygments

マークアップ変換

マークダウンのmarkdown
再構造化テキストのdocutils
textile用テキスタイル

オプション

-wフラグを使用した監視/自動再生用のwatchdog
PDF エクスポート用の Prince

インストール

pipのような Python パッケージマネージャーを使用して、Landslide の最新の安定バージョンをインストールします。

 $ pip install landslide

最先端の状況を維持したい場合は、次のようにします。

 $ git clone https://github.com/adamzap/landslide.git
$ cd landslide
$ python setup.py build
$ sudo python setup.py install

書式設定

マークダウン

Markdown ソースファイルの接尾辞は.md 、 .markdn 、 .mdwn 、 .mdown 、または.markdownである必要があります。
タイトルスライドを作成するには、単一のh1要素をレンダリングします (例: # My Title )
md ファイルの末尾を除き、スライドを水平罫線 (マークダウンの--- ) で区切ります。
他のスライドには、 h1要素にレンダリングされる見出しが必要です。
コードのブロックを強調表示するには、最初のインデント行として!lang ( langは pygment でサポートされている言語識別子) を入力します。

再構造化されたテキスト

ReST ソースファイルには、接尾辞として.rstまたは.restを付ける必要があります ( .txtはサポートされていません)。
スライドのタイトルに見出しを使用する
RST ファイルの最後を除き、水平罫線 (RST では---- ) を使用してスライドを区切ります。

繊維

マークダウンと同じように、 ---使用してスライドを区切ります。

レンダリング

landslide slides.mdまたはlandslide slides.rstを実行します。
新しく生成されたpresentation.htmlをお楽しみください。

または、Prince がシステムにインストールされており利用可能な場合は、PDF ドキュメントとして取得します。

 $ landslide README.md -d readme.pdf
$ open readme.pdf

見る

hを押してヘルプの表示を切り替えます
left arrowとright arrow押して移動します
t押して、プレゼンテーションの目次を切り替えます。スライドのタイトルはリンクです
ESC押してプレゼンテーションの概要を表示します (Exposé)
nを押してスライド番号の表示を切り替えます
bを押して画面のブランキングを切り替えます
cを押して、現在のスライドのコンテキスト (前のスライドと次のスライド) を切り替えます。
eを押すと、文書本文内の利用可能なスペース全体を埋めるスライドが作成されます。
Sを押すと、各スライドのソースファイルへのリンクの表示が切り替わります。
スライド内のノートを切り替えるには、「2」を押します (.notes マクロで指定します)。
「3」を押すと擬似 3D 表示が切り替わります (実験的)
ブラウザのズーム機能がサポートされています

コマンドラインオプション

コマンドラインを使用していくつかのオプションを使用できます。

 -h, --help            show this help message and exit
-c, --copy-theme      Copy theme directory into current presentation source
                      directory
-b, --debug           Will display any exception trace to stdin
-d FILE, --destination=FILE
                      The path to the to the destination file: .html or .pdf
                      extensions allowed (default: presentation.html)
-e ENCODING, --encoding=ENCODING
                      The encoding of your files (defaults to utf8)
-i, --embed           Embed stylesheet and javascript contents,
                      base64-encoded images in presentation to make a
                      standalone document
-l LINENOS, --linenos=LINENOS
                      How to output linenos in source code. Three options
                      availables: no (no line numbers); inline (inside                       tag); table (lines numbers in another cell, copy-paste
                      friendly)
-o, --direct-output    Prints the generated HTML code to stdout; won't work
                      with PDF export
-q, --quiet           Won't write anything to stdout (silent mode)
-r, --relative        Make your presentation asset links relative to current
                      pwd; This may be useful if you intend to publish your
                      html presentation online.
-t THEME, --theme=THEME
                      A theme name, or path to a landlside theme directory
-v, --verbose         Write informational messages to stdin (enabled by
                      default)
-w, --watch           Watch the source directory for changes and
                      auto-regenerate the presentation
-x EXTENSIONS, --extensions=EXTENSIONS
                      Comma-separated list of extensions for Markdown
-m, --math-output     Enable mathematical output using mathjax

プレゼンテーションの構成

Landslide では、 cfg構成ファイルを使用してプレゼンテーションを構成できるため、ソースディレクトリの集約とプレゼンテーション間での再利用が容易になります。 Landslide 構成ファイルはcfg構文を使用します。 iniファイルを知っている場合は、イメージがわかります。以下は設定ファイルの例です。

 [landslide]
theme  = /path/to/my/beautiful/theme
source = 0_my_first_slides.md
         a_directory
         another_directory
         now_a_slide.markdown
         another_one.rst
destination = myWonderfulPresentation.html
css =    my_first_stylesheet.css
         my_other_stylesheet.css
js =     jquery.js
         my_fancy_javascript.js
relative = True
linenos = inline

[landslide]セクションを申告することを忘れないでください。すべての構成ファイルは .cfg 拡張子で終わる必要があります。

設定どおりにプレゼンテーションを生成するには、次を実行するだけです。

 $ cd /path/to/my/presentation/sources
$ landslide config.cfg

マクロ

マクロを使用してプレゼンテーションを強化できます。

注意事項

.notes:キーワードを使用してスライドにメモを追加します。例:

 # My Slide Title

.notes: These are my notes, hidden by default

My visible content goes here

2キーを押すとノートの表示を切り替えることができます。

他のいくつかのマクロもデフォルトで使用できます。 .fx: foo bar対応するスライドの

要素にfooとbarクラスを追加し、CSS を使用したプレゼンテーションのスタイルを容易にします。

QRコード

.qrキーワードを使用して、プレゼンテーションに QR コードを追加します。

 .qr: 450|http://github.com/adamzap/landslide

発表者メモ

スライドのコンテンツに「発表者ノート」という見出しを付けて、各スライドに発表者ノートを追加することもできます。「p」キーを押してプレゼンタービューを開きます。

マクロの登録

マクロは、スライドの HTML コンテンツを変換するために使用されます。

独自のマクロを登録するには、 landslide.macro.Macro派生クラスを作成し、 process(content, source=None)メソッドを実装し、変更されたコンテンツとスライドに追加するいくつかの CSS クラスを含むタプルを返します

要素。例えば：

 !python
import landslide

class MyMacro(landslide.Macro):
  def process(self, content, source=None):
    return content + 'plop', ['plopped_slide']

g = landslide.generator.Generator(source='toto.md')
g.register_macro(MyMacro)
print g.render()

これにより、以下のようにスライドがレンダリングされます。

 !html

  foo
  
    my slide contents
    plop

高度な使用法

カスタム宛先ファイルの設定

 $ landslide slides.md -d ~/MyPresentations/presentation.html

ディレクトリの操作

 $ landslide slides/

直接出力の操作

 $ landslide slides.md -o | tidy

代替地滑りテーマの使用

 $ landslide slides.md -t mytheme
$ landslide slides.md -t /path/to/theme/dir

Base-64 でエンコードされた画像の埋め込み

 $ landslide slides.md -i

PDF へのエクスポート

 $ landslide slides.md -d presentation.pdf

数学的表記を有効にする

 Note that this require writing the slides in ReST format as well as
using Docutils 0.8 or newer.

$ landslide slides.rst -m

Markdown 拡張機能の有効化

利用可能な Markdown 拡張機能については、こちらのドキュメントを参照してください。

 $ landslide slides.md -x abbr

テーマ設定

Landslide テーマは、次の単純な構造に従ったディレクトリです。

 mytheme/
|-- base.html
|-- css
|   |-- print.css
|   `-- screen.css
`-- js
    `-- slides.js

テーマで HTML および JS ファイルが提供されていない場合は、デフォルトのテーマのファイルが使用されます。 CSS はオプションではありません。

最後に、 --copy-themeオプションをlandslideコマンドに渡すことで、テーマディレクトリ全体をプレゼンテーションにコピーすることもできます。

 $ landslide slides.md -t /path/to/some/theme --copy-theme

ユーザースタイルシートとJavaScript

独自のテーマをわざわざ作成したくない場合は、生成されたプレゼンテーションに独自のユーザー CSS および JS ファイルを含めることができます。

この機能は、 cssフラグやjsフラグを設定することによって、地滑り設定ファイルを使用する場合にのみ使用できます。

 [landslide]
theme  = /path/to/my/beautiful/theme
source = slides.mdown
css =    custom.css
js =     jquery.js
         powerpoint.js

これらは、 custom.cssスタイルシートと、プレゼンテーション HTML ファイルのセクション内のjquery.jsファイルとpowerpoint.jsファイルの両方をリンクします。

注: css および js ファイルへのパスは、 landslideコマンドを実行しているディレクトリからの相対パスである必要があります。

プレゼンテーションをオンラインで公開する

HTML プレゼンテーションをオンラインで公開する場合は、プレゼンテーションのルートを基準にしてすべてのアセットリンクを設定するには、 --copy-themeオプションと同様に--relativeオプションを使用する必要があります。

 $ landslide slides.md --relative --copy-theme

そうすれば、プレゼンテーションディレクトリ全体を Web サーバーにホストするだけで済みます。もちろん、圧倒的なプレゼンテーションをホストするには、Python も PHP も、HTTP Web サーバー (Nginx など) 以外は必要ありません。

テーマ変数

base.html次のテンプレート変数を利用できる Jinja2 テンプレートファイルである必要があります。

css : スタイルシートの内容。 printとscreen 2 つのキーで使用できます。どちらも次のとおりです。
- アセットファイルパスへの URL を保存するpath_urlキー
- アセットのコンテンツを格納するcontentsキー
js : 以下を含む JavaScript コンテンツ:
- アセットファイルパスへの URL を保存するpath_urlキー
- アセットのコンテンツを格納するcontentsキー
slides : スライドのリスト。各スライドには次のプロパティがあります。
- header : スライドのタイトル
- content : スライドの内容
- number : スライド番号
embed : 現在のドキュメントはスタンドアロンですか?
num_slides : 現在のプレゼンテーションのスライドの数
toc : ドキュメントのセクションをリストした目次。各セクションでは次のプロパティを使用できます。
- title : セクションのタイトル
- number : セクションのスライド番号
- sub : サブセクション (存在する場合)