thurstylark
/
tlwiki
1
0
Fork 0
Code Issues 6 Pull Requests Projects Releases Wiki Activity
tlwiki/Vimwiki.wiki

140 lines
4.7 KiB
Plaintext
Raw Normal View History

initial commit
2017-01-04 21:40:01 +00:00
= Vimwiki =
== TODO ==
Use JQuery to add .table to every table element in order to use Bootstrap table style. Add doccumentation about this change
2017-01-04 23:01:47 +00:00
* [X] Commit to a repository
Added documentation for vimwiki and LetsEncrypt
2017-01-05 03:52:56 +00:00
* [X] Setup remote to host
* [X] Setup remote to automatically `:VimwikiAll2HTML` after it's been pushed to
initial commit
2017-01-04 21:40:01 +00:00
Use JQuery to add .table to every table element in order to use Bootstrap table style. Add doccumentation about this change
2017-01-04 23:01:47 +00:00
== Table tweaks ==
Tables without any styles are gross, so let's use the styles from Bootstrap. Problem is that Vimwiki doesn't provide a way to add a class to a table element, so we'll do it with JQuery:
{{{class="prettyprint"
Added documentation for vimwiki and LetsEncrypt
2017-01-05 03:52:56 +00:00
<head>
...
<script>
$(document).ready(function(){
$("table").addClass("table table-condensed table-hover");
});
</script>
...
</head>
Use JQuery to add .table to every table element in order to use Bootstrap table style. Add doccumentation about this change
2017-01-04 23:01:47 +00:00
}}}
This adds `.table`, `.table-condensed`, and `.table-hover` classes to every table element in the whole document. Don't see why it should be any other way for the moment.
=== References ===
http://stackoverflow.com/a/39897883
http://www.w3schools.com/jquery/jquery_syntax.asp
initial commit
2017-01-04 21:40:01 +00:00
== HTML Checkboxes ==
By default, there is no difference between how a non-checkbox list item, unchecked list item, and a checked list item are displayed when exported to HTML.
There are 5 states of a checkbox, 0-4, and they each represent a different level of completeness. This is mainly for checklist items with children.
Checkbox states:
Use JQuery to add .table to every table element in order to use Bootstrap table style. Add doccumentation about this change
2017-01-04 23:01:47 +00:00
| State # | % Complete | li class | Unicode character | Escape sequence | HTML code |
|---------|------------|----------|-------------------|-----------------|------------|
| 0 | 0% | `done0` | ◯ | `\u25EF` | `&#9711;` |
| 1 | 1-33% | `done1` | ◔ | `\u25D4` | `&#9684;` |
| 2 | 34-66% | `done2` | ◑ | `\u25D1` | `&#9681;` |
| 3 | 67-99% | `done3` | ◕ | `\u25D5` | `&#9685;` |
| 4 | 100% | `done4` | ✔ | `\u2714` | `&#10004;` |
initial commit
2017-01-04 21:40:01 +00:00
Now, in order to use these in our HTML, we just have to write a style for `ul li.doneX:before` in our header like so:
{{{class="prettyprint linenums" >
<style>
ul li.done0:before {content: '\25EF';}
ul li.done1:before {content: '\25D4';}
ul li.done2:before {content: '\25D1';}
ul li.done3:before {content: '\25D5';}
ul li.done4:before {content: '\2714';}
</style>
}}}
Now here's a few test lists:
* [ ] Unfinished item
* [X] Finished item
* [.] Parent item 1
* [X] Child item 1
* [ ] Child item 2
* [ ] Child item 3
* [ ] Child item 4
* [o] Parent item 2
* [X] Child item 1
* [X] Child item 2
* [ ] Child item 3
* [ ] Child item 4
* [O] Parent item 3
* [X] Child item 1
* [X] Child item 2
* [X] Child item 3
* [ ] Child item 4
* [X] Parent item 4
* [X] Child item 1
* [X] Child item 2
* [X] Child item 3
* [X] Child item 4
* [ ] Parent item 5
* [ ] Child item 1
* [ ] Child item 2
* [ ] Child item 3
* [ ] Child item 4
Added documentation for vimwiki and LetsEncrypt
2017-01-05 03:52:56 +00:00
== Push to Deploy ==
The easiest way to manage this wiki, and also allow it to be hosted, is to commit all the wiki documents to a repo, and script the deployment to the wiki's webroot using git's post-receive hook. The origin remote repo also hosts the http server, so it makes things simple. Less simple because it requires a vim plugin to compile the HTML files, but it's still doable.
First part of this solution is the vimrc for the remote machine. This sets the destination for the final html files, the origin wiki files, and the html template page.
{{{class="prettyprint linenums"
set nocompatible
filetype plugin on
syntax on
let g:vimwiki_list = [{
\ 'path': '/tmp/vimwiki/',
\ 'path_html': '/srv/wiki/',
\ 'template_path': '/tmp/vimwiki/html-template',
\ 'template_default': 'index',
\ 'template_ext': '.html'}]
}}}
Note: lines 1-3 are required for vimwiki to work correctly with the post-receive hook. The rest of the config are options for vimwiki directly.
The post-receive hook is a fairly simple bash script. This script is located at `~/git/vimwiki.git/hooks/post-receive`, and is run every time the repo receives a push from downstream.
{{{class="prettyprint linenums"
#!/bin/bash
mkdir /tmp/vimwiki
export GIT_WORK_TREE=/tmp/vimwiki
export GIT_DIR=/home/thurstylark/git/vimwiki.git
git checkout -f
vim -u /tmp/vimwiki/html-template/srv-vimrc -c VimwikiAll2HTML -c q /tmp/vimwiki/index.wiki
cp /tmp/vimwiki/html-template/slate.bootstrap.min.css /srv/wiki/
rm -rf /tmp/vimwiki
}}}
It first makes a directory under /tmp for the contents of the repo, sets `$GIT_WORK_TREE` and `$GIT_DIR`, and does a `git checkout` for all the files in the repo.
Line 9 is where the magic happens. This line runs vim with the vimrc from above, and runs the `:VimwikiAll2HTML` command.
Next, the script copies over the one CSS file that I need to host myself, and lastly, it cleans up the temp dir.
== TODO ==
* [X] Commit to a repository
* [X] Setup remote to host
* [X] Setup remote to automatically `:VimwikiAll2HTML` after it's been pushed to
* [ ] Document push to deploy