Skip to content

Commit 01c5902

Browse files
committed
update the readme
1 parent b62b059 commit 01c5902

File tree

3 files changed

+51
-27
lines changed

3 files changed

+51
-27
lines changed

.gitignore

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
*.gem
2+
*.rbc
3+
/.config
4+
/coverage/
5+
/InstalledFiles
6+
/pkg/
7+
/spec/reports/
8+
/test/tmp/
9+
/test/version_tmp/
10+
/tmp/
11+
12+
## Specific to RubyMotion:
13+
.dat*
14+
.repl_history
15+
build/
16+
17+
## Documentation cache and generated files:
18+
/.yardoc/
19+
/_yardoc/
20+
/doc/
21+
/rdoc/
22+
23+
## Environment normalisation:
24+
/.bundle/
25+
/lib/bundler/man/
26+
27+
# for a library or gem, you might want to ignore these files since the code is
28+
# intended to run in multiple environments; otherwise, check them in:
29+
# Gemfile.lock
30+
# .ruby-version
31+
# .ruby-gemset
32+
33+
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
34+
.rvmrc

README.md

+17-25
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,29 @@
1-
$Revision$
2-
$LastChangedDate$
3-
4-
51
Plain Text Wiki
62
===============
73

84
Plain Text Wiki is a TextMate bundle which allows you to use a directory of
95
text files as a simple wiki.
106

7+
It works in TextMate 1, and I use it in TextMate 2. If you find any issues, please let me know.
8+
119
The bundle is by Matt Webb <http://interconnected.org/home>.
1210

1311

1412
Installation
1513
------------
1614

17-
Download and unzip Plain-Text-Wiki.zip. Double-click on the bundle to install
15+
Download the repo. Double-click on "Plain Text Wiki.tmbundle" to install
1816
(the bundle requires TextMate: <http://macromates.com>).
1917

2018

2119
Usage
2220
-----
2321

2422
* Create a new directory
25-
* In TextMate, choose 'Create New Wiki' from the menu
26-
Bundles > Plain Text Wiki
23+
* In TextMate, choose 'Create New Wiki' from the menu Bundles > Plain Text Wiki
2724
* Select your new directory. A file 'IndexPage.txt' will be created and opened
28-
* Reference new pages using CamelCase or [[like this]]. Page names will appear
29-
underlined
30-
* To follow a link, put the text cursor over a page name and hit Enter (not
31-
Return)
25+
* Reference new pages using CamelCase or [[like this]]. Page names will appear underlined
26+
* To follow a link, put the text cursor over a page name and hit Enter (not Return. On laptops this might be fn+Return)
3227

3328
Return to the index page at any time: Type shift+ctrl+i
3429

@@ -38,19 +33,13 @@ Insert a list of pages by typing 'pagelist' and hitting tab.
3833
Export as HTML
3934
--------------
4035

41-
Choose 'Export Wiki as HTML' from the Plain Text Wiki commands menu. You will
42-
be prompted for a directory where the Web pages will be saved (please make
43-
sure it's empty).
36+
Choose 'Export Wiki as HTML' from the Plain Text Wiki commands menu. You will be prompted for a directory where the Web pages will be saved (please make sure it's empty).
4437

45-
For converting text to HTML, Plain Text Wiki understands Markdown:
46-
http://daringfireball.net/projects/markdown/syntax
38+
For converting text to HTML, Plain Text Wiki understands Markdown: http://daringfireball.net/projects/markdown/syntax
4739

48-
To customise the HTML of the wiki, add wiki-styles.css to the project
49-
directory--it'll be copied to the export directory and included.
40+
To customise the HTML of the wiki, add wiki-styles.css to the project directory--it'll be copied to the export directory and included.
5041

51-
For more control, add wiki-header.html and wiki-footer.html to the project
52-
directory. Include the string "%s" in wiki-header.html to have that replaced
53-
with the page title on export.
42+
For more control, add wiki-header.html and wiki-footer.html to the project directory. Include the string "%s" in wiki-header.html to have that replaced with the page title on export.
5443

5544

5645
Bugs and issues
@@ -60,15 +49,19 @@ Please let me know about any bugs. Patches are welcome!
6049

6150
Issues:
6251

63-
* The text.html.markdown language grammar, and grammar to underline http-style
64-
URLs, should be included
52+
* The text.html.markdown language grammar, and grammar to underline http-style URLs, should be included
6553
* Bundle needs to adhere to http://macromates.com/wiki/Bundles/StyleGuide
6654
* Grammar binds to a number of file extensions, but exports only '.txt'
6755

6856

6957
Changes
7058
-------
7159

60+
2014-09-25:
61+
62+
* Moved repo to GitHub
63+
* Removed the zipped bundle and the script to make the zip
64+
7265
2007-06-10:
7366

7467
* Fixed Create New Wiki command (which was not working)
@@ -85,5 +78,4 @@ Changes
8578
Miscellaneous
8679
-------------
8780

88-
More background to Plain Text Wiki:
89-
http://interconnected.org/home/2007/05/20/plain_text_wiki
81+
More background to Plain Text Wiki: http://interconnected.org/home/2007/05/20/plain_text_wiki

makezip

-2
This file was deleted.

0 commit comments

Comments
 (0)