-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Restore sample skeleton autogeneration. Slightly modify the builtin themes handling: now copy the whole theme directory without polluting excessively the original markdown source.
- Loading branch information
Showing
315 changed files
with
16,879 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# How to contribute | ||
|
||
This project is open source, therefore, anyone interested to use, to develop or to contribute to it is welcome. | ||
|
||
The project must remain KISS (Keep It Simple and Stupid) thus a few guidelines for contributing are provided. | ||
|
||
## Issues Handling | ||
|
||
If you find issues (bugs or new features requests) you are kindly requested to highlight them on the GitHub repository. | ||
|
||
+ Make sure you have a [GitHub account](https://github.com/signup/free); | ||
+ submit a ticket for your issue, assuming one does not already exist; | ||
+ clearly describe the issue including steps to reproduce when it is a bug; | ||
+ make sure you fill in the earliest version that you know has the issue. | ||
|
||
Alternatively, you can signal issues directly to the main developer at stefano.zaghi@gmail.com. | ||
|
||
## Collaborative Development | ||
|
||
If you like to directly contribute to the project you are welcome. To improve the collaborative development of the project you are kindly requested to respect the following guidelines. | ||
|
||
+ Fork the repository on GitHub; | ||
+ create a topic branch from where you want to base your work; | ||
+ this is usually the master branch: | ||
+ only target release branches if you are certain your fix must be on that branch; | ||
+ to quickly create a topic branch based on master; `git branch fix/master/my_contribution master` then checkout the new branch with `git checkout fix/master/my_contribution`; please avoid working directly on the `master` branch; | ||
+ check for unnecessary whitespace with `git diff --check` before committing; | ||
+ make sure your commit messages are clear; | ||
+ make sure you have properly tested for your changes. | ||
|
||
As long as possible, contributors are kindly requested to follow the current coding style of the project (two white spaces instead of tabs, no trailing white spaces, blank lines should not have any space). In general, it is strongly recommended to avoid Microsoft-Windows-like carriage-return symbols in order to not pollute the source files with unnecessary symbols. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
include *.md | ||
recursive-include matisse *.css *.js *.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
#!/usr/bin/env python | ||
"""Wrapper of MaTiSSe.py program extracted from matisse package""" | ||
from matisse.matisse import main | ||
if __name__ == '__main__': | ||
main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Metadata-Version: 1.1 | ||
Name: MaTiSSe.py | ||
Version: 1.2.2 | ||
Summary: MaTiSSe.py, Markdown To Impressive Scientific Slides | ||
Home-page: https://github.com/szaghi/MaTiSSe | ||
Author: Stefano Zaghi | ||
Author-email: stefano.zaghi@gmail.com | ||
License: UNKNOWN | ||
Description: MaTiSSe.py, Markdown To Impressive Scientific Slides. It is a very simple and stupid-to-use (KISS) presentation maker based on simple markdown syntax producing high quality first-class html/css presentation with great support for scientific contents. | ||
Platform: UNKNOWN | ||
Classifier: Development Status :: 5 - Production/Stable | ||
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3) | ||
Classifier: Environment :: Console | ||
Classifier: Intended Audience :: End Users/Desktop | ||
Classifier: Programming Language :: Python | ||
Classifier: Programming Language :: Python :: 2 | ||
Classifier: Programming Language :: Python :: 2.7 | ||
Classifier: Programming Language :: Python :: 3 | ||
Classifier: Programming Language :: Python :: 3.4 | ||
Classifier: Topic :: Text Processing |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
[console_scripts] | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
markdown | ||
yattag | ||
pyyaml | ||
dirsync |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
matisse |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
<a name="top"></a> | ||
# MaTiSSe.py [![Latest Version](https://img.shields.io/pypi/v/MaTiSSe.py.svg)](https://img.shields.io/pypi/v/MaTiSSe.py.svg) [![GitHub tag](https://img.shields.io/github/tag/szaghi/MaTiSSe.svg)]() | ||
|
||
[![Join the chat at https://gitter.im/szaghi/MaTiSSe](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/szaghi/MaTiSSe?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) | ||
|
||
[![License](https://img.shields.io/badge/license-GNU%20GeneraL%20Public%20License%20v3,%20GPLv3-blue.svg)]() | ||
|
||
### MaTiSSe.py, Markdown To Impressive Scientific Slides | ||
MaTiSSe.py is a very simple and stupid (KISS) presentation maker based on simple `markdown` syntax producing high quality first-class html/css presentation with great support for scientific contents. | ||
|
||
+ MaTiSSe.py is **NOT** *WYSIWYG*: it converts your sources to high quality html presentation with the same approach of LaTeX typesetting; | ||
+ MaTiSSe.py is tailored to scientific contents (equations, figures, tables, etc...); | ||
+ MaTiSSe.py is a Command Line Tool; | ||
+ MaTiSSe.py is a Free, Open Source Project. | ||
|
||
### Status | ||
|
||
[![Build Status](https://travis-ci.org/szaghi/MaTiSSe.svg?branch=master)](https://travis-ci.org/szaghi/MaTiSSe) | ||
[![Coverage Status](https://img.shields.io/coveralls/szaghi/MaTiSSe.svg)](https://coveralls.io/r/szaghi/MaTiSSe) | ||
[![Code Health](https://landscape.io/github/szaghi/MaTiSSe/master/landscape.svg?style=flat)](https://landscape.io/github/szaghi/MaTiSSe/master) | ||
|
||
#### Issues | ||
[![GitHub issues](https://img.shields.io/github/issues/szaghi/MaTiSSe.svg)]() | ||
[![Ready in backlog](https://badge.waffle.io/szaghi/matisse.png?label=ready&title=Ready)](https://waffle.io/szaghi/matisse) | ||
[![In Progress](https://badge.waffle.io/szaghi/matisse.png?label=in%20progress&title=In%20Progress)](https://waffle.io/szaghi/matisse) | ||
[![Open bugs](https://badge.waffle.io/szaghi/matisse.png?label=bug&title=Open%20Bugs)](https://waffle.io/szaghi/matisse) | ||
|
||
#### Python support [![Supported Python versions](https://img.shields.io/badge/Py-%202.7,%203.4-blue.svg)]() | ||
|
||
#### Documentation | ||
|
||
MaTiSSe.py has a comprehensive [wiki](https://github.com/szaghi/MaTiSSe/wiki): read it to know how to install and use MaTiSSe.py. | ||
|
||
#### A Taste of MaTiSSe.py | ||
See MaTiSSe.py in action with the [getting started presentation](http://szaghi.github.io/MaTiSSe/#/slide-1) or see the following screenshots. | ||
|
||
##### The Titlepage | ||
![shot01](screenshots/01.png) | ||
|
||
##### Figure environment | ||
![shot02](screenshots/02.png) | ||
|
||
##### LaTeX Equations support | ||
![shot03](screenshots/03.png) | ||
|
||
##### LaTeX-Beamer Themes support | ||
![shot04](screenshots/04.png) | ||
|
||
Go to [Top](#top) | ||
|
||
## Main Features | ||
MaTiSSe.py has a too much long list of features. Here the main features are listed whereas for a complete list read all the documentation material (examples, wiki, etc...). | ||
|
||
* [x] `markdown-to-html` slides maker (with extended markdown syntax); | ||
* [ ] support for structured, long presentations: | ||
* [x] presentation metadata; | ||
* [x] presentation sectioning: | ||
* [x] `titlepage`; | ||
* [x] `section`; | ||
* [x] `subsection`; | ||
* [x] `slide`; | ||
* [ ] helpers: | ||
* [x] `TOC`; | ||
* [x] `countdown timer`; | ||
* [ ] `navigation controls`; | ||
* [x] easy theming: | ||
* [x] `canvas`; | ||
* [x] `headings` (h1,h2,...); | ||
* [x] global slide theme as well theme of a specific slide (local slide theme): | ||
* [x] `headers` (unlimited number); | ||
* [x] `footers` (unlimited number); | ||
* [x] `left and right sidebars` (unlimited number); | ||
* [x] `content`; | ||
* [x] `beamer-like-styles` support; | ||
* [x] `latex equations` support; | ||
* [x] `scientific contents` support: | ||
* [x] `boxes` with fully customizable environment; | ||
* [x] `figures` with fully customizable environment; | ||
* [ ] `tables` with fully customizable environment; | ||
* [x] `notes` with fully customizable environment; | ||
* [x] `code listings` with syntax highlighting; | ||
* [x] `columns` fully customizable environment; | ||
* [ ] `note handouts` support; | ||
* [x] `impress.js` support; | ||
* [ ] `jmpress.js` support; | ||
* [ ] `reveal.js` support; | ||
|
||
## Copyrights | ||
MaTiSSe.py is an open source project, it is distributed under the [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html) license. A copy of the license should be distributed within MaTiSSe.py. Anyone interested to use, develop or to contribute to MaTiSSe.py is welcome. Take a look at the [contributing guidelines](CONTRIBUTING.md) for starting to contribute to the project. | ||
|
||
Go to [Top](#top) |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
"""Package defining the MaTiSSe.py program.""" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
#!/usr/bin/env python | ||
"""Wrapper for extracting matisse.main() function.""" | ||
from .matisse import main | ||
if __name__ == '__main__': | ||
main() |
Oops, something went wrong.