https://github.com/tonyfast/matlab-bootstrap-gh

A Publishing System for Matlab Scripts and Structures that is served using GH-Pages with a bootstrap template.
https://github.com/tonyfast/matlab-bootstrap-gh

Last synced: 11 days ago
JSON representation

A Publishing System for Matlab Scripts and Structures that is served using GH-Pages with a bootstrap template.

• Host: GitHub
• URL: https://github.com/tonyfast/matlab-bootstrap-gh
• Owner: tonyfast
• Created: 2014-05-16T15:29:49.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-10-28T15:09:10.000Z (about 10 years ago)
• Last Synced: 2024-10-11T19:25:23.654Z (about 1 month ago)
• Language: Matlab
• Size: 436 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Matlab-Bootstrap-GH

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

This repository assists in publishing Matlab codes and variables into blog-aware webpages for rapid dissmeination of information.

* Matlab-Bootstrap-GH contains Bootstrap 3

* Installs the file directory structure for Jekyll

* Creates html websites and webpages for Matlab data and codes in Git repositories

## Components

* ``matinpublish`` - pubishes Matlab scripts and Matlab structures to .html pages that contain metadata about the script or variable.

The output files contain YAML front-matter that is interpretted by Jekyll on the ``gh-pages`` branch served by [Github Page](http://pages.github.com).

## Disclaimer

** Research science contains a few endpoints Software, Publication, Pedagogy, and Reproducibility.  The research science process is very interactive

so I personally reserve the ``master`` branch for vetted software codes.  I tend to work off of the ``gh-pages`` branch while I am doing research

because Matlab-Bootstrap-GH makes it really easy to host intermediate results. **

## Getting Started

1. ``git checkout -b gh-pages`` - work out of the ``gh-pages`` branch

2. execute ``matinpublish('init')`` - The ``init`` argument sets up all of the Jekyll and Bootstrap dependencies that are managed in the ``gh-pages`` branch is this repo.

3. edit ``_config.yml`` - Add your user information.

## DISQUS - A global comment system

[DISQUS](www.disqus.com) is a free global comment system for webpages.  In this versiuon ``mbgh``, the universal DISQUS commenting html snippet is added at the end of each dataset and report.  The comment systems attachs the conversation of data and codes directly alongside the source.

#### Activating Disqus

1. Please go to [DISQUS](www.disqus.com)

2. Register for a username.

3. Place your username in the ``_config.yml`` next to the field ``disqus``.

4. Afterwards each post with have a comment box.

   * Comments and activity can be monitored on [DISQUS](www.disqus.com)

## [An Example PAGE](http://tonyfast.com/Matlab-Bootstrap-GH/2014/05/17/Initializing-Github-Pages%2C-Jekyll%2C-and-Bootstrap.html)