https://github.com/alexpreynolds/biostar-handbook-web

Online companion for the Biostar Handbook.
https://github.com/alexpreynolds/biostar-handbook-web

Last synced: 4 months ago
JSON representation

Online companion for the Biostar Handbook.

• Host: GitHub
• URL: https://github.com/alexpreynolds/biostar-handbook-web
• Owner: alexpreynolds
• License: other
• Created: 2016-04-08T23:14:01.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-04-09T03:38:54.000Z (about 9 years ago)
• Last Synced: 2024-12-26T17:27:26.597Z (6 months ago)
• Language: HTML
• Homepage: https://www.biostarhandbook.com
• Size: 1.91 MB
• Stars: 8
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

### Biostar Handbook

This repository is an online companion for the Biostar Handbook:

See: https://www.biostarhandbook.com/

### Contributors

* Istvan Albert, https://github.com/ialbert

* Phil Ross, https://github.com/thephilross

Contributions need to be made via GitHub: https://github.com/ialbert/biostar-handbook-web

### Requirements

The web pages are generated with the [pyblue](https://github.com/ialbert/pyblue) 

static site generator from the git repository above. Install pyblue:

    pip install pyblue

To view and edit the site run `make` in the repository. The default action

in the `make` file supports the main usecase of developing new content.

It will start the pyblue server instance and will allow you

to view the result of any changes you make to the pages.

    make

    

Visit `http://localhost:8080` to see the site. Edit any page in

an editor then reload in web browser. See the pyblue docs for

other details.

Restart the server if you add a new file as the directory tree 

is scanned only once on startup. Changes to files however will 

be visible right away.

### Content

Content is divided into subdirectories of the  `www/unit` directory. 

1. Web units need to contain all commands used to generate a result.

1. Comments should be used to explain the purpose of each command

1. A web unit can be a plain HTML file,

   may contain markdown as well as Django Templating specific commands.

1. Start with the [example.html](https://github.com/ialbert/biostar-handbook-web/blob/master/www/unit/example.html) 

   file in the repository. Now examine how this file gets rendered at

   [http://biostarhandbook.com/unit/example.html](http://biostarhandbook.com/unit/example.html)

1. Code can be embedded into pages 

   (will be automatically syntax highlighted) or can be linked to as a file.

1. Bootstrap 2.3 styling is enabled.

You can also consult the [pyblue documentation](http://ialbert.github.io/pyblue/) for more details.