Skip to content

Commit f2ca30d

Browse files
Add frequently unasked questions
Signed-off-by: Chris Cummer <chriscummer@me.com>
1 parent 99ca45c commit f2ca30d

File tree

5 files changed

+17
-1
lines changed

5 files changed

+17
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
.DS_Store
2+
/bin/*

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<p align="center"><img src="till_header.png" width="916" height="306" alt="til" title="til: jot it down" /></p>
1+
<p align="center"><img src="images/till_header.png" width="916" height="306" alt="til" title="til: jot it down" /></p>
22

33
`til` is a fast, simple, command line-driven, mini-static site generator I use for quickly capturing and publishing one-off notes. Two commands, (three if you're picky about your commit messages).
44

@@ -26,6 +26,7 @@ And you're done.
2626
* [Building, saving, committing, and pushing](#building-saving-committing-and-pushing)
2727
* [Publishing to GitHub Pages](#publishing-to-github-pages)
2828
* [Live Example](#live-example)
29+
* [Frequently Unasked Questions](#frequently-unasked-questions)
2930

3031
## Installation
3132

@@ -92,6 +93,8 @@ That new page will open in whichever editor you've defined in your config.
9293

9394
Builds the index and tag pages, and leaves them uncommitted.
9495

96+
<p align="center"><img src="images/til_build.png" width="600" height="213" alt="image of the build process" title="til -build" /></p>
97+
9598
### Building, saving, committing, and pushing
9699

97100
```bash
@@ -106,6 +109,8 @@ Builds the index and tag pages, commits everything to the git repo with the comm
106109

107110
`-save` takes an optional commit message. If that message is supplied, it will be used as the commit message. If that message is not supplied, the `commitMessage` value in the config file will be used. If that value is not supplied, an error will be raised.
108111

112+
<p align="center"><img src="images/til_save.png" width="600" height="259" alt="image of the save process" title="til -save" /></p>
113+
109114
## Publishing to GitHub Pages
110115

111116
The generated output of `til` is such that if your `git remote` is configured to use GitHub, it should be fully compatible with GitHub Pages.
@@ -115,3 +120,13 @@ Follow the [GitHub Pages setup instructions](https://guides.github.com/features/
115120
## Live Example
116121

117122
An example published site: [https://senorprogrammer.github.io/tilde/](https://senorprogrammer.github.io/tilde/). And the raw source: [github.com/senorprogrammer/tilde](https://github.com/senorprogrammer/tilde)
123+
124+
## Frequently Unasked Questions
125+
126+
### Isn't this just (insert your favourite not this thing here)?
127+
128+
Yep, probably. You could also likely do something like this with [Hugo](https://gohugo.io), [Jekyll](https://jekyllrb.com), bash scripts, emacs some custom lisp macros.... How cool is that?
129+
130+
### Does it have search?
131+
132+
It does not.

images/til_build.png

70.4 KB
Loading

images/til_save.png

83.9 KB
Loading
File renamed without changes.

0 commit comments

Comments
 (0)