Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
caesr-pub
jekyll-scholar
Commits
48fab94c
Commit
48fab94c
authored
Jan 12, 2016
by
Sylvester Keil
Browse files
Merge pull request #122 from reitzig/patch-1
Updates README as proposed at issues #108, #109
parents
4364e907
60d2630b
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
48fab94c
...
...
@@ -24,6 +24,20 @@ Or add it to your `Gemfile`:
gem 'jekyll-scholar'
### Github Pages
Note that it is not possible to use this plugin with the
[
default Github pages workflow
](
https://help.github.com/articles/using-jekyll-with-pages/
)
.
Github does not allow any but a few select plugins to run for security reasons,
and Jekyll-Scholar is not among them.
You will have to generate your site locally and push the results to the
`master`
resp.
`gh-pages`
branch of your site repository.
You can keep sources, configuration and plugins in a separate branch; see e.g.
[
here
](
http://davidensinger.com/2013/07/automating-jekyll-deployment-to-github-pages-with-rake/
)
for details.
Usage
-----
...
...
@@ -66,8 +80,11 @@ default configuration is as follows:
You can use any style that ships with
[
CiteProc-Ruby
](
https://github.com/inukshuk/citeproc-ruby
)
by name (e.g.,
apa, mla, chicago-fullnote-bibliography), or else you can add a link
to any CSL style (e.g., you could link to any of the styles available at
apa, mla, chicago-fullnote-bibliography) which is usually the filename as seen
[
here
](
https://github.com/citation-style-language/styles
)
sans the
`.csl`
ending; note that you have to use
`dependent/style`
if you want
to use one from that directory.
Alternatively you can add a link to any CSL style (e.g., you could link to any of the styles available at
the official
[
CSL style repository
](
https://github.com/citation-style-language/styles
)
).
The
`locale`
settings defines what language to use when formatting
...
...
Write
Preview
Supports
Markdown
0%
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!
Cancel
Please
register
or
sign in
to comment