https://github.com/genmon/plaintextwiki
https://github.com/genmon/plaintextwiki
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/genmon/plaintextwiki
- Owner: genmon
- Created: 2014-09-25T12:21:32.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-05-13T16:48:06.000Z (about 10 years ago)
- Last Synced: 2025-04-19T10:35:19.646Z (about 1 year ago)
- Language: Ruby
- Size: 120 KB
- Stars: 9
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Plain Text Wiki
===============
Plain Text Wiki is a TextMate bundle which allows you to use a directory of
text files as a simple wiki.
It works in TextMate 1, and I use it in TextMate 2. If you find any issues, please let me know.
The bundle is by Matt Webb .
Installation
------------
Download the repo. Double-click on "Plain Text Wiki.tmbundle" to install
(the bundle requires TextMate: ).
Usage
-----
* Create a new directory
* In TextMate, choose 'Create New Wiki' from the menu Bundles > Plain Text Wiki
* Select your new directory. A file 'IndexPage.txt' will be created and opened
* Reference new pages using CamelCase or [[like this]]. Page names will appear underlined
* To follow a link, put the text cursor over a page name and hit Enter (not Return. On laptops this might be fn+Return)
Return to the index page at any time: Type shift+ctrl+i
Insert a list of pages by typing 'pagelist' and hitting tab.
Export as HTML
--------------
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).
For converting text to HTML, Plain Text Wiki understands Markdown: http://daringfireball.net/projects/markdown/syntax
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.
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.
Bugs and issues
---------------
Please let me know about any bugs. Patches are welcome!
Issues:
* The text.html.markdown language grammar, and grammar to underline http-style URLs, should be included
* Bundle needs to adhere to http://macromates.com/wiki/Bundles/StyleGuide
* Grammar binds to a number of file extensions, but exports only '.txt'
Changes
-------
2014-09-25:
* Moved repo to GitHub
* Removed the zipped bundle and the script to make the zip
2007-06-10:
* Fixed Create New Wiki command (which was not working)
2007-06-09:
* Added 'Insert Page List'
* 'Follow Page Link' now ignores case when looking for a text file to open
* Export now looks for wiki-styles.css, wiki-header.html and wiki-footer.html
* Various bugs fixed in way Export adds HTML links
* Export prompts to replace files in the export directory
Miscellaneous
-------------
More background to Plain Text Wiki: http://interconnected.org/home/2007/05/20/plain_text_wiki