hbpmedical / specifications

Specifications for the MIP platform

Specifications

Specifications for the MIP platform

Modifications and contributions to the site

The site is built from Markdown content using Hugo to generate the HTML code.

Development is done on the master branch of this repository, HTML pages should go to the gh-pages branch.

To get started, type the following in a command line. You will need Git version 2.7 or better and Docker.

  git clone [email protected]:HBPMedical/specifications
  cd specifications
  ./after-git-clone.sh

This will create the folder specifications.pages that contains the HTML pages to be published on Github.io.

Use the following command to run Hugo as a local server, available on localhost:1313. Any change you do on Markdown files will be updated immediately in the local site.

  ./run.sh

Commit regularly your changes, ideally indicating what what changed, for example

  git commit -a -m "Add new User Documentation page"

When you are ready to publish, follow those steps:

  # commit all your work
  git add --all .
  git commit -m "<My changes>"
  # push the changes on the master branch
  git push
  # build the site
  ./build.sh
  # publish the new site
  cd ../specifications.pages
  git add --all .
  git commit -m "<My changes>"
  git push

Done.

Online editing

You can use the following services to contribute to the site:

• Appernetic
  • Collaborating and working with Hugo themes
  • Manage your website images in the cloud
  • Why use a static website generator?
  • Gitter channel for support
• Forestry

Please be careful when publishing your changes back to Github.