Merge branch 'ikistrap' into 'master'

Use the Ikistrap theme



See merge request !2
This commit is contained in:
Achilleas Pipinellis 2016-07-07 08:24:54 +00:00
commit d0fbd9dbc1
27 changed files with 285 additions and 24 deletions

2
.gitignore vendored
View file

@ -1,2 +1,2 @@
/.ikiwiki
content/.ikiwiki
public/

View file

@ -1,15 +1,22 @@
image: elecnix/ikiwiki
before_script:
- apt-get install -y git
- git submodule init
- git submodule update
test:
stage: test
script: ikiwiki --setup .ikiwiki/ikiwiki.setup
script:
- ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib
only:
- branches
- tags
pages:
stage: deploy
script: ikiwiki --setup .ikiwiki/ikiwiki.setup
script:
- ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib
artifacts:
paths:
- public

3
.gitmodules vendored Normal file
View file

@ -0,0 +1,3 @@
[submodule "themes/ikistrap"]
path = themes/ikistrap
url = https://github.com/gsliepen/ikistrap.git

View file

@ -29,28 +29,41 @@ defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):
```yaml
image: elecnix/ikiwiki
before_script:
- apt-get install -y git
- git submodule init
- git submodule update
test:
stage: test
script: ikiwiki --setup .ikiwiki/ikiwiki.setup
except:
- master
script:
- ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
only:
- branches
- tags
pages:
stage: deploy
script: ikiwiki --setup .ikiwiki/ikiwiki.setup
script:
- ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib
artifacts:
paths:
- public
only:
- master
```
We are using a theme based on Bootstrap 4 using submodules, and in order to
enable the theme plugin, we must pass the `libdir` parameter.
## Building locally
To work locally with this project, you'll have to follow the steps below:
1. Fork, clone or download this project
1. [Install][] ikiwiki
1. Generate the website: `ikiwiki --setup .ikiwiki/ikiwiki.setup`
1. Clone the submodules: `git submodule init && git submodule update`
1. Generate the website: `ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib`
1. Preview your project: open `public/index.html` in a browser
Read more at ikiwiki's [documentation][].
@ -83,4 +96,4 @@ unless you want to contribute back to the upstream project.
[install]: https://ikiwiki.info/install/
[documentation]: https://ikiwiki.info/
[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages

BIN
content/Anemones.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

View file

@ -0,0 +1,136 @@
# Bootstrap features
This page will contain a display of various features from Bootstrap.
They require some manual HTML tags.
Note that not all Markdown parsers allow Markdown markup inside all HTML tags.
In the case of ikiwiki, adding `markdown="1"` to `div` elements usually allows markup to be used inside them.
For a full list of features provided by Bootstrap 4, go to <http://v4-alpha.getbootstrap.com/getting-started/introduction/>.
<div class="jumbotron" markdown="1">
## Jumbotron
It's big and in your face.
---
You can still use Markdown syntax inside HTML blocks, if you are careful.
<a class="btn btn-primary btn-large" href="#">Button</a>
</div>
## Labels <span class="label label-info">Hi!</span>
Span elements work inside Markdown headings.
<div class="card card-block" markdown="1">
## Cards
Put a border with soft round corners around your content.
</div>
## Card decks
These require some more work.
You can use the `\[[!img]]` directive, but make sure to add `class="card-img-top"` or `class="card-img-bottom"` where appropriate.
For images in cards to work properly, they need to have their width forced to 100% of their container.
This is done in the `style.css` file that comes with ikistrap.
Another issue is that due to all the nested HTML tags, even with `markdown="1"`, Markdown markup does not get parsed anymore.
<div class="card-deck">
<div class="card-deck-wrapper">
<div class="card">
[[!img Lemonshark.jpg alt="Lemon shark" class="card-img-top"]]
<div class="card-block">
<p class="card-text">
A lemon shark and his little friends are out for a swim.
</p>
<p><a href="#" class="btn btn-danger">Escape</a></p>
</div>
</div>
<div class="card">
[[!img Anemones.jpg alt="Anemones" class="card-img-top"]]
<div class="card-block">
<p class="card-text">
Anemones look really nice and are much less dangerous than lemon sharks.
</p>
<p><a href="#" class="btn btn-success">Admire</a></p>
</div>
</div>
<div class="card">
[[!img Sea_Star.jpg alt="Sea star" class="card-img-top"]]
<div class="card-block">
<p class="card-text">
Sea stars are also less dangerous than lemon sharks, but they are slightly more dangerous than
anemones, <em>especially</em> when stepped on.
</p>
<p><a href="#" class="btn btn-warning">Sidestep</a></p>
</div>
</div>
</div>
</div>
## Card columns
These can be created by writing the outer card-columns `div` elements yourself,
and using `\[[!inline]]` with `template="simplecard"` to generate the cards.
<div class="card-columns">
[[!inline pages="sample_text/* and !*/Discussion" template="simplecard" feeds="no"]]
</div>
## Carousel
These can be created by writing the outer two carousel `div` elements yourself,
and using `\[[!inline]]` with `template="carouselpage"` to generate the carousel items.
<p>
<div id="carousel-example-pages" class="carousel slide" data-ride="carousel">
<ol class="carousel-indicators"></ol>
<div class="carousel-inner" role="listbox">
[[!inline pages="sample_text/* and !*/Discussion" template="carouselpage" feeds="no"]]
</div>
<a class="left carousel-control" href="#carousel-example-pages" role="button" data-slide="prev">
<span class="icon-prev" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="right carousel-control" href="#carousel-example-pages" role="button" data-slide="next">
<span class="icon-next" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>
</p>
If you only want to show images, use `template="carouselimage"`, and select your images directly with the `pages` parameter.
<p>
<div id="carousel-example-images" class="carousel slide" data-ride="carousel">
<div class="carousel-inner" role="listbox">
[[!inline pages="*.jpg" template="carouselimage" feeds="no"]]
</div>
<a class="left carousel-control" href="#carousel-example-images" role="button" data-slide="prev">
<span class="icon-prev" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="right carousel-control" href="#carousel-example-images" role="button" data-slide="next">
<span class="icon-next" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>
</p>
## Progress bars
Ikistrap also provides a progress directive which works in the same way as the progress plugin,
but it also allows an extra class to be specified to change the style per bar.
[[!progress totalpages="* and !*/Discussion" donepages="*/Discussion"]]
[[!progress percent="33%"]]
[[!progress percent="66%" class="progress-success progress-striped"]]
## Other stuff
Goes here.

10
content/Calendars.mdwn Normal file
View file

@ -0,0 +1,10 @@
# Calendar
This is an example of the ikiwiki calendar function.
Here is a monthly calendar:
[[!calendar type="month"]]
And this is a yearly calendar:
[[!calendar type="year"]]

3
content/Comments.mdwn Normal file
View file

@ -0,0 +1,3 @@
# Comments
This is an example of a page where comments are allowed.

View file

@ -0,0 +1,9 @@
[[!comment format=mdwn
username="Anonymous Coward"
subject="Indeed"
date="2009-06-02T19:05:00Z"
content="""
Hi, I just want to say that I totally agree with you.
Have a nice day!
"""
]]

View file

@ -0,0 +1,9 @@
[[!comment format=mdwn
username="Pseudonymous Person"
subject="I am disagree"
date="2009-06-02T19:05:01Z"
content="""
I don't think so. Eggs should neither be capped at the top or at the bottom.
Symmetry is only attained by slicing it in half in a plane spanned by the line between the top and bottom.
"""
]]

View file

@ -0,0 +1,9 @@
# Inline pages
Here is an example of inline pages using the default inlining theme:
[[!inline pages="sample_text/* and !*/Discussion" reverse="yes" limit="3"]]
Here is an example of inlining with actions enabled:
[[!inline pages="sample_text/* and !*/Discussion" reverse="yes" skip="3" limit="2" actions="1"]]

BIN
content/Lemonshark.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
content/Sea_Star.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

31
content/index.mdwn Normal file
View file

@ -0,0 +1,31 @@
# Welcome to Ikiwiki hosted by GitLab Pages
This is an example wiki to show off how Ikiwiki is deployed with [GitLab Pages].
It uses the [Ikistrap] theme which provides a fully-featured, modern looking
HTML5 theme for ikiwiki. It uses Bootstrap 4 and Fonts Awesome.
## Features
Ikistrap has the following features:
* Good use of HTML5 semantic elements.
* Responsive layout.
* Standards-compliant.
* Compatible with text-only browsers.
* Header supporting parentlinks, wiki actions, search form, language selection and trails.
* Sidebar styled as a Boostrap 4 card, using the Bootstrap 4 grid system.
* Footer that is pushed down to the bottom of the screen with tags, backlinks, copyright, license and modification date.
* [[Inline pages]] that are by default styled as Bootstrap 4 cards.
* [[Comments]]
* [[Calendars]]
Note that ikistrap doesn't add any special support for Bootstrap to the Markdown language.
If you want to make use of [[Bootstrap features]] inside your text, you will have to manually add the appropriate HTML tags.
## Contribute
If you want to contribute to this website, visit <https://gitlab.com/pages/ikiwiki>.
[gitlab pages]: https://pages.gitlab.io
[ikistrap]: https://github.com/gsliepen/ikistrap

1
content/inlinetest.mdwn Normal file
View file

@ -0,0 +1 @@
[[!inline pages="sample_text/*"]]

View file

@ -0,0 +1 @@
Donec dapibus orci sit amet elit. Maecenas rutrum ultrices lectus. Aliquam suscipit, lacus a iaculis adipiscing, eros orci pellentesque nisl, non pharetra dolor urna nec dolor. Integer cursus dolor vel magna. Integer ultrices feugiat sem. Proin nec nibh. Duis eu dui quis nunc sagittis lobortis. Fusce pharetra, enim ut sodales luctus, lectus arcu rhoncus purus, in fringilla augue elit vel lacus. In hac habitasse platea dictumst. Aliquam erat volutpat. Fusce iaculis elit id tellus. Ut accumsan malesuada turpis. Suspendisse potenti. Vestibulum lacus augue, lobortis mattis, laoreet in, varius at, nisi. Nunc gravida. Phasellus faucibus. In hac habitasse platea dictumst. Integer tempor lacus eget lectus. Praesent fringilla augue fringilla dui.

View file

@ -0,0 +1 @@
Donec semper, sem nec tristique tempus, justo neque commodo nisl, ut gravida sem tellus suscipit nunc. Aliquam erat volutpat. Ut tincidunt pretium elit. Aliquam pulvinar. Nulla cursus. Suspendisse potenti. Etiam condimentum hendrerit felis. Duis iaculis aliquam enim. Donec dignissim augue vitae orci. Curabitur luctus felis a metus. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. In varius neque at enim. Suspendisse massa nulla, viverra in, bibendum vitae, tempor quis, lorem.

View file

@ -0,0 +1,4 @@
[[!meta author="Cicero"]]
[[!meta date="45 B.C."]]
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed at ante. Mauris eleifend, quam a vulputate dictum, massa quam dapibus leo, eget vulputate orci purus ut lorem. In fringilla mi in ligula. Pellentesque aliquam quam vel dolor. Nunc adipiscing. Sed quam odio, tempus ac, aliquam molestie, varius ac, tellus. Vestibulum ut nulla aliquam risus rutrum interdum. Pellentesque lorem. Curabitur sit amet erat quis risus feugiat viverra. Pellentesque augue justo, sagittis et, lacinia at, venenatis non, arcu. Nunc nec libero. In cursus dictum risus. Etiam tristique nisl a nulla. Ut a orci. Curabitur dolor nunc, egestas at, accumsan at, malesuada nec, magna.

View file

@ -0,0 +1,2 @@
[[!tag Cicero Latin typesetting]]
Nulla facilisi. Nunc volutpat. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Ut sit amet orci vel mauris blandit vehicula. Nullam quis enim. Integer dignissim viverra velit. Curabitur in odio. In hac habitasse platea dictumst. Ut consequat, tellus eu volutpat varius, justo orci elementum dolor, sed imperdiet nulla tellus ut diam. Vestibulum ipsum ante, malesuada quis, tempus ac, placerat sit amet, elit.

View file

@ -0,0 +1 @@
Sed eget turpis a pede tempor malesuada. Vivamus quis mi at leo pulvinar hendrerit. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Pellentesque aliquet lacus vitae pede. Nullam mollis dolor ac nisi. Phasellus sit amet urna. Praesent pellentesque sapien sed lacus. Donec lacinia odio in odio. In sit amet elit. Maecenas gravida interdum urna. Integer pretium, arcu vitae imperdiet facilisis, elit tellus tempor nisi, vel feugiat ante velit sit amet mauris. Vivamus arcu. Integer pharetra magna ac lacus. Aliquam vitae sapien in nibh vehicula auctor. Suspendisse leo mauris, pulvinar sed, tempor et, consequat ac, lacus. Proin velit. Nulla semper lobortis mauris. Duis urna erat, ornare et, imperdiet eu, suscipit sit amet, massa. Nulla nulla nisi, pellentesque at, egestas quis, fringilla eu, diam.

9
content/sidebar.mdwn Normal file
View file

@ -0,0 +1,9 @@
This is the sidebar.
* [[/index]]
* [[ikiwiki]]
* [[sandbox]]
* [[shortcuts]]
* [[templates]]
``Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam tortor augue, lacinia eget libero eget, imperdiet scelerisque neque. Nam pretium dui sit amet rhoncus commodo. Sed eget faucibus purus, vel vulputate nulla. Sed accumsan odio ac dui vulputate, non venenatis velit iaculis. Quisque efficitur orci in tellus tincidunt, non maximus nisi finibus. Vestibulum tristique id eros ut dictum. Integer congue euismod metus, at feugiat nunc sagittis quis. Curabitur iaculis mi eget volutpat sodales. Ut nec dui et mi cursus tempor ac et sem. Nulla felis neque, congue tristique ultricies a, vehicula a ante.''

View file

@ -0,0 +1,4 @@
[[!meta title="pages tagged Cicero"]]
[[!inline pages="tagged(Cicero)" actions="no" archive="yes"
feedshow=10]]

View file

@ -0,0 +1,4 @@
[[!meta title="pages tagged Latin"]]
[[!inline pages="tagged(Latin)" actions="no" archive="yes"
feedshow=10]]

View file

@ -0,0 +1,4 @@
[[!meta title="pages tagged typesetting"]]
[[!inline pages="tagged(typesetting)" actions="no" archive="yes"
feedshow=10]]

View file

@ -16,7 +16,7 @@ adminuser: []
# users who are banned from the wiki
banned_users: []
# where the source of the wiki is located
srcdir: ./
srcdir: ./content
# where to build the wiki
destdir: ./public
# base url to the wiki
@ -38,13 +38,23 @@ only_committed_changes: 0
# rcs backend to use
rcs: ''
# plugins to add to the default configuration
add_plugins: []
add_plugins:
- 404
- goodstuff
- favicon
- google
- sidebar
- highlight
- typography
- ikistrap
# plugins to disable
disable_plugins: []
# additional directory to search for template files
templatedir: /usr/share/ikiwiki/templates
templatedir: ../ikistrap/templates
#templatedir: /usr/share/ikiwiki/templates
# base wiki source location
underlaydir: /usr/share/ikiwiki/basewiki
#underlaydir: /usr/share/ikiwiki/basewiki
underlaydir: ../ikistrap/basewiki
# display verbose messages?
verbose: 1
# log to syslog?

View file

@ -1,11 +0,0 @@
Welcome to [ikiwiki] hosted on [GitLab Pages](https://pages.gitlab.io)!
[[!toc ]]
# Heading 1
I'm a level 1 heading.
## Heading 2
I'm a level 2 heading.

1
themes/ikistrap Submodule

@ -0,0 +1 @@
Subproject commit 16bcffa6ed030c62d8a6d0c5b25db6f5ae45999c