-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
jekyll.txt
92 lines (76 loc) · 2.98 KB
/
jekyll.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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
styles: features, dev features, news, releases, site pages
categories for posts: release, news, devel?
or tags: news, docs
front pager -- latest version, build: travis, coverity, rss
post "short" yaml header => 1 paragraph => no "Read more..."
front page status box : features (16/4) or (16/20)
no. status *PAGE*
jq concertina on feature pages default to all open
icons on features: (✓) green, (!) yellow, (X) red
good, warning, bad
put on top right of page
tooltip => safe to use, etc
status page, list of features, icons against 1.5.24, 1.6.0
generate automatically from YAML
build: travis, coverity
post categories have icons {rel, dev, news, docs}
colour code too? NO, to twee
prev/next floating bottom-right
tidy css
posts sidebar: either list subset of posts centred around current
or say <|Prev|3/6|Next|> for context
make the manual sections part of a collection for simplicity?
easier to theme them, header, footer
posts YAML: pinned: true => front page display 1 news + pinned!
pin latest release -- no need, do it by type
if latest is release -- show it, if not show news + latest release
travis on website? see jekyll-sitemap/travis.yml
features: link (at top) to src, diff against m24
reinstate "Buy Rich a Beer?" allowed on GitHub?
do I need a mutt-devel branch separate from neomutt?
probably not -- they're not independent of each other
sub-branches from neomutt for each task [task/bools]
features: status: stable, warning, devel? (doc this where?)
Goals for neomutt?
jekyll/github pages howto
clone website
gem install
jekyll + jekyll-X plugins
bundler
or disable plugins in _config.yml
j-mentions?
gem install github-pages
(all deps needed)
put in a docker (search first)
jekyll setup from minimal install
root:
dnf update
dnf install -y git rubygems ruby-devel make gcc redhat-rpm-config g++-devel gcc-c++ zlib-devel
user:
gem install github-pages bundler jekyll-{gist,sitemap,algolia,mentions}
git clone https://github.com/neomutt/neomutt.github.io
jekyll serve
create minimal jekyll template to support separate code doc repo
jekyll page type "hidden" -- don't list
website jekyll serve instructions
jekyll:
gem install nokogiri -- --use-system-libraries
gem install github-pages
gem install jekyll-algolia
gem install i18n bigdecimal
The website's built using Jekyll -- a static site generator.
Jekyll's written in Ruby. You'll need to install some Ruby devel
packages first (distro-dependent), then it _should_ be as simple as:
gem install github-pages
gem install jekyll-algolia
Once installed, clone the website:
git clone --branch dyk https://github.com/neomutt/neomutt.github.io
and run the local webserver:
cd neomutt.github.io
jekyll serve
http://127.0.0.1:4000/
The website takes about 10s to build/update, so I recommend:
jekyll serve --incremental --livereload
There's now a top-level menu "Did You Know?", with some sample pages.
Adding a new page is as simple as adding a new file in the /dyk dir.
(the table is auto-generated)