forked from barryclark/jekyll-now
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.txt
68 lines (47 loc) · 2.17 KB
/
README.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
Building locally
----------------
Install the jekyll Ruby module(s):
[ >export GEM_HOME=~/.gem # if you don't have admin rights ]
>gem install jekyll
>gem install jekyll-paginate # for multipage blog listings
Run jekyll in 'watch' mode to update as you modify files (restart if _config.yml
changes):
jekyll serve --watch &
View the locally served page at:
http://127.0.0.1:4000
Overall site config
-------------------
_data/settings.yml
Settings here include what to show on the landing page.
Editing/adding news posts
-------------------------
_posts/*.md
File names should start with a date in the form YYYY-MM-DD. The format is
Markdown, but files begin with "front matter" between two "---" lines, which
is YAML formatted and used for metadata. Current (optional) front matter
variables used:
title: The title of the post (the file name without the leading date or any
dashes is used if missing)
authors: List of authors, keyed to file names in _people/, but without ".md"
(http://yaml.org/type/seq.html)
excerpt: Optional short description to show in lists. If not provided,
everything up to the excerpt delimiter (defined in _data/settings.yml) will
be used, or the entire post if there is no delimiter.
comments: Currently true by default; set to false to disable
(http://yaml.org/type/bool.html)
Editing/adding data
-------------------
_people/*.md
_projects/*.md
_data/publications/*.yml
For People and Projects, file names will be used for sorting, and the prefixes
for these and for Publications (no ".md" or ".yml") can be used as keys for
cross-referencing in the YAML "front matter" (between the "---" lines). Though
files for People and Projects are Markdown formatted, the data in their YAML
front matter is used to generate their corresponding pages, and Markdown content
below this is currently ignored. Publications are only used as a data source and
do not have individual pages, hence the pure YAML format. See existing files for
relevant variables and syntax or the complete schema:
schema.pptx
Images can be placed in img/ and can be referenced from YAML as "/img/[...]",
including any subdirectories.