Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 2.49 KB

README.md

File metadata and controls

49 lines (39 loc) · 2.49 KB
Raw

Build Status license

DeepLearnPhysics.github.io

A repository for the DeepLearnPhysics group top webpage for group descriptions. The master branch holds static HTML files generated by Pelican with uno theme. The develop branch holds the source code to generate the website.

Requirement

You need the python packages:

  • pelican >= 3.5.0
  • markdown >= 2.6.9

How to contribute (develop)

For awesome you to help development, follow the following three steps: installation, compilation, development, and publish.

Installation

  1. Join the web-blog github team
  2. Clone the repo: git clone [email protected]:DeepLearnPhysics/DeepLearnPhysics.github.io.
  3. Make sure you are on the develop branch by git branch

Compilation

By compilation we mean the generation of static HTMLs. This is fairly simple:

  1. make html

Development

Our development work is a process of modify-compile-check. The first to-do is:

  1. Open pelicanconf.py and uncomment the line #SITEURL = ''. This generates HTMLs to be viewed locally.
  2. make devserver then access localhost:8000 on your browser. This runs a virtual pelican web server on your machine and allows you to browse the updated website contents all on your laptop.
  3. Make modifications you wish to make. The content directory is where you make a blog post.
  4. make html will update your local static website.

Publish

After you finish your development work, if you want to publish your change on our website, you have to push your changes.

  1. Open pelicanconf.py and comment out the line SITEURL = ''. This generates HTMLs to be viewed on the shared remote server.
  2. make html and if you are running a local virtual server, make stopserver.
  3. Commit your changes to the develop branch.
  4. git checkout master ... the master branch holds static website contents.
  5. cp -r output/* ./
  6. git add .
  7. git commit -m "your message"
  8. git push

Done!

Copyright and license

It is under the MIT license.