Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
psvg.doc.ic.ac.uk
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Verified Software
psvg.doc.ic.ac.uk
Commits
c1ec9327
There was a problem fetching the pipeline summary.
Commit
c1ec9327
authored
7 years ago
by
Thomas Wood
Browse files
Options
Downloads
Patches
Plain Diff
Update README.md [ci skip]
parent
34147842
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Pipeline
#
Changes
1
Pipelines
2
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+28
-0
28 additions, 0 deletions
README.md
with
28 additions
and
0 deletions
README.md
+
28
−
0
View file @
c1ec9327
...
...
@@ -55,6 +55,34 @@ Any other files present in the directory structure (except for those prefixed wi
For the detail of adding publication, please refer to the README file in publication directory.
Jekyll Scholar Configuration Detail
===================================
We desire the output URL structure to be:
* `/publications/`
* `index.html` - a page listing the entire bibliography
* `publications.bib` - the raw bibtex file, directly from the source
* `Key.html` - details page generated for each publication
* `Key.*` - Any files associated with each publication, copied directly from the source
In the `scholar` section of the configuration file, configuration options we've used are:
* `source`: Directory in which our bibtex files are to be found (`publications`)
* `details_dir`: Directory to output `Key.html` files for each publication (`publications`), rendered using the layout
defined in the `details_layout` option.
* `details_link`: We override the default here, as we generate our own HTML to render this link in our
`bibliography_template`.
* `repository`: Location of files associated with publications (`publications`) (the same
directory is used for both input and output: it is handled as usual by jekyll)
The template used to generate individual publication pages is [here](layout). The part of interest is the Source
Materials section. We iterate through a [predefined list of file types](file-types) and output a link (using icon and
text from the file type list) to the file in the repository if it exists.
Finally, in order to generate the complete biography page, we use a [page](index) in the site's root just outputting a
`{% bibliography %}` as normal (which renders each entry using the layout defined by the scholar `bibliography_template`
option). By using a `permalink` jekyll option we place the rendered bibliography into the `/publications/` output
directory as `index.html`.
Testing and Deployment
----------------------
The DoC GitLab instance is configured (using .gitlab-ci.yml) to build, test and deploy the website on tests passing.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment