PacELF Digital Library
A static site for storing and searching the PacELF project's digital library of documents.
To install this project, you'll need the following things installed on your machine.
- Clone this repo, or download it into a directory of your choice.
- Inside the project's root directory, run:
To simply serve the site locally and/or to see development changes to the Jekyll datasets, layouts or includes, run;
bundle exec jekyll serve --watch --incremental
This will output a localhost development server.
To remove existing content in
_site, which is where Jekyll builds to and serves from, run:
bundle exec jekyll clean
To rebuild the content of
bundle exec jekyll build
See the Jekyll docs for more options.
Re-compile the files using the provided
webpack.config.js configuration using:
npm run build
package.json for more commands and details.
Currently this codebase requires the
xml documents contain the information about documents curated by the PacELF project, the
.txt contains information about the availability of the document itself and the
Process to obtain XML documents
Currently there is a spreadsheet which is maintained by the PacELF project.
The spreadsheet is converted into
.xml documents via a Python script.
TODO: Test this process and confirm which one actually works with Daniel
Producing markdown document for each XML document
Once the XML documents are in located in
docs/ you can install the Python dependencies in
Pipfile using your preferred tool.
pip3 install -r requirements.txt
Then you can run the script
With luck it will populate the
_datasets/ folder with the original markdown output of each XML document.
Deployments via GitHub
The site is deployed by GitHub Pages to https://pacelf.github.io/
Changes can be made to deployed site by making changes to the GitHub repository
master branch via:
To locally run the tests on the static site produced, first install the project dependencies above.
Then install the testing dependencies via:
gem install html-proofer
Build the static site via:
bundle exec jekyll build
Run the tests:
JKAN is organised in a particular way to suit it's usecase and it is helpful to understand before making changes. The architecture and development of it is documented here.
Per PacELF project's request, Google Analytics is loaded into the site to count viewers.
It is currently stored under
firstname.lastname@example.org Google Analytics account.
As requested, it sends monthly audience overview emails to
email@example.com which are forwarded to Patricia Graves (firstname.lastname@example.org) as the PacELF project owner.