pyscf/pyscf.github.io-v1

PySCF website

PySCF website

The PySCF website runs on GitHub Pages using Jekyll, with styling based on Twitter Bootstrap. GitHub Pages runs Jekyll automatically and builds the website out of source files contained in this repository.

Bootstrap

The site uses a few drop-in files from a Bootstrap distribution, which require special placement for Jekyll/GitHub Pages compatibility. Sass files that compile to CSS are found in _sass/bootstrap/* and Javascript files are found in assets/javascript/bootstrap/*. These files need to be replaced by hand in order to use a new Bootstrap distribution.

Local development and testing

The Jekyll-based build requires a Ruby installation. Next, install Bundler

$ gem install bundler

In the top level directory of the website repository, install Jekyll and other dependencies from the GitHub Pages gem (see Gemfile):

$ bundle install

To keep the site up to date with the GitHub Pages gem,

$ bundle update

After making any changes, you can build and view the site locally,

$ bundle exec jekyll serve

which will build and serve the website out of http://127.0.0.1:4000.

References

• Official Jekyll page on GitHub Pages
• Setting up your GitHub Pages site locally with Jekyll
• Creating and Hosting a Personal Site on GitHub
• 5 Steps To Add Bootstrap 4 To Jekyll The Right Way
• Bootstrap 4 Github Pages