mirror of
https://github.com/joaotavora/yasnippet.git
synced 2025-10-13 13:13:03 +00:00
using an org-mode readme, too
This commit is contained in:
Joao Tavora
parent
b0a986b761
commit
bdcecc0fe5
99
README.mdown
99
README.mdown
@ -1,99 +0,0 @@
|
||||
# Intro
|
||||
|
||||
**YASnippet** is a template system for Emacs. It allows you to type an
|
||||
abbreviation and automatically expand it into function
|
||||
templates. Bundled language templates includes: C, C++, C#, Perl,
|
||||
Python, Ruby,
|
||||
|
||||
SQL, LaTeX, HTML, CSS and more. The snippet syntax is inspired from
|
||||
[TextMate's][textmate-snippets] syntax, you can even
|
||||
[import][import-docs] most TextMate templates to YASnippet. Watch
|
||||
[a demo on YouTube][youtube-demo] or download a
|
||||
[higher resolution version][high-res-demo]
|
||||
|
||||
[textmate-snippets]: http://manual.macromates.com/en/snippets
|
||||
[import-docs]: http://yasnippet.googlecode.com/svn/trunk/doc/snippet-development.html#importing-textmate-snippets
|
||||
[youtube-demo]: http://www.youtube.com/watch?v=ZCGmZK4V7Sg
|
||||
[high-res-demo]: http://yasnippet.googlecode.com/files/yas_demo.avi
|
||||
|
||||
# Installation
|
||||
|
||||
## Install the most recent version
|
||||
|
||||
Clone this repository somewhere
|
||||
|
||||
$ cd ~/.emacs.d/plugins
|
||||
$ git clone https://github.com/capitaomorte/yasnippet
|
||||
|
||||
Add the following in your `.emacs` file:
|
||||
|
||||
(add-to-list 'load-path
|
||||
"~/.emacs.d/plugins/yasnippet")
|
||||
(require 'yasnippet)
|
||||
(yas/global-mode 1)
|
||||
|
||||
Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas/new-snippet`.
|
||||
|
||||
## Install yasnippet with el-get
|
||||
|
||||
El-get is a nice way to get the most recent version, too
|
||||
|
||||
See https://github.com/dimitri/el-get for instructions
|
||||
|
||||
# Contributing snippets
|
||||
|
||||
Please do not ask me to add snippets to the default collection under
|
||||
`/snippets`. This is considered frozen and by customizing
|
||||
`yas/snippet-dirs` you can point yasnippet to good snippet collections
|
||||
out there.
|
||||
|
||||
There is a tool `extras/textmate-import.rb` than can import many
|
||||
actual Textmate snippets and there are
|
||||
`extras/imported/*-mode/.yas-setup.el` files that can help it with the
|
||||
more difficult importation.
|
||||
|
||||
I'm focusing on developping `textmate-import.rb` tool and the
|
||||
`yas-setup.el` files. In the future `/snippets` snippets will be
|
||||
deprecated and replaced with `extras/imported`.
|
||||
|
||||
Follow through the following example to start using these snippets for
|
||||
rails development. It will convert `ruby`, `rails` and `html` bundles
|
||||
from drnic's github repositories based on corresponding
|
||||
`.yas-setup.el` files.
|
||||
|
||||
## Using imported textmate snippets (rails example)
|
||||
|
||||
After cloning this repository to `~/.emacs.d/plugins/yasnippet`
|
||||
|
||||
cd ~/.emacs.d/plugins/yasnippet
|
||||
git submodule init
|
||||
git submodule update
|
||||
gem install plist trollop
|
||||
rake convert_bundles # will convert ruby, rails and html bundles from drnic
|
||||
|
||||
Then, in your .emacs file
|
||||
|
||||
(add-to-list 'load-path
|
||||
"~/.emacs.d/plugins/yasnippet")
|
||||
(require 'yasnippet)
|
||||
(setq yas/snippet-dirs '("~/.emacs.d/snippets" "~/.emacs.d/extras/imported"))
|
||||
(yas/global-mode 1)
|
||||
|
||||
Open some rails file (model, app, etc) and start using the textmate snippets.
|
||||
|
||||
# Documentation, issues, etc
|
||||
|
||||
Please refer to the comprehensive [documentation] [docs] for full customization
|
||||
and support. If you find a bug, please report it on
|
||||
[the GitHub issue tracker][issues]. (please **do not** submit new issues to the old
|
||||
[googlecode tracker][googlecode tracker])
|
||||
|
||||
If you run into problems using YASnippet, or have snippets to contribute, post
|
||||
to the [yasnippet google group][forum]. Thank you very much for using YASnippet!
|
||||
|
||||
[docs]: http://capitaomorte.github.com/yasnippet/
|
||||
[issues]: https://github.com/capitaomorte/yasnippet/issues
|
||||
[googlecode tracker]: http://code.google.com/p/yasnippet/issues/list
|
||||
[forum]: http://groups.google.com/group/smart-snippet
|
||||
|
||||
|
||||
102
README.org
Normal file
102
README.org
Normal file
@ -0,0 +1,102 @@
|
||||
# -*- mode: org; fill-column: 80 -*-
|
||||
#+TITLE: Yet another snippet extension
|
||||
#+OPTIONS: toc:1
|
||||
#+STARTUP: showall
|
||||
|
||||
#+STYLE: <link rel="stylesheet" type="text/css" href="assets/stylesheet.css" />
|
||||
|
||||
# External links
|
||||
#
|
||||
#+LINK: smart-snippet http://code.google.com/p/smart-snippet
|
||||
#+LINK: pluskid http://pluskid.lifegoo.org
|
||||
|
||||
|
||||
#+LINK: screencast http://www.youtube.com/watch?v=ZCGmZK4V7Sg
|
||||
#+LINK: docs http://capitaomorte.github.com/yasnippet
|
||||
#+LINK: issues https://github.com/capitaomorte/yasnippet/issues
|
||||
#+LINK: googlecode-tracker http://code.google.com/p/yasnippet/issues/list
|
||||
#+LINK: forum http://groups.google.com/group/smart-snippet
|
||||
|
||||
*YASnippet* is a template system for Emacs. It allows you to type an
|
||||
abbreviation and automatically expand it into function templates. Bundled
|
||||
language templates includes: C, C++, C#, Perl, Python, Ruby, SQL, LaTeX, HTML,
|
||||
CSS and more. The snippet syntax is inspired from TextMate's syntax, you can
|
||||
even [[#import-textmate][import most TextMate snippets]]
|
||||
|
||||
YASnippet is an original creation of [[pluskid]] who also wrote its predecessor
|
||||
[[smart-snippet]].
|
||||
|
||||
* Watch a demo [[screencast]]
|
||||
|
||||
* Install the most recent version with git
|
||||
|
||||
Clone this repository somewhere
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
$ cd ~/.emacs.d/plugins
|
||||
$ git clone https://github.com/capitaomorte/yasnippet
|
||||
#+END_EXAMPLE
|
||||
|
||||
Add the following in your =.emacs= file:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
(add-to-list 'load-path
|
||||
"~/.emacs.d/plugins/yasnippet")
|
||||
(require 'yasnippet)
|
||||
(yas/global-mode 1)
|
||||
#+END_EXAMPLE
|
||||
|
||||
Add your own snippets to `~/.emacs.d/snippets` by placing files there or invoking `yas/new-snippet`.
|
||||
|
||||
* Install yasnippet with el-get
|
||||
|
||||
[[https://github.com/dimitri/el-get.gti][El-get]] is a nice way to get the most recent version.
|
||||
|
||||
* Import textmate snippets (rails example)
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: import-textmate
|
||||
:END:
|
||||
|
||||
Clone the yasnippet repository to `~/.emacs.d/plugins/yasnippet`
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
cd ~/.emacs.d/plugins/yasnippet
|
||||
git submodule init
|
||||
git submodule update
|
||||
gem install plist trollop
|
||||
rake convert_bundles # will convert ruby, rails and html bundles from drnic
|
||||
#+END_EXAMPLE
|
||||
|
||||
Then, in your .emacs file
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
(add-to-list 'load-path
|
||||
"~/.emacs.d/plugins/yasnippet")
|
||||
(require 'yasnippet)
|
||||
(setq yas/snippet-dirs '("~/.emacs.d/snippets" "~/.emacs.d/extras/imported"))
|
||||
(yas/global-mode 1)
|
||||
#+END_EXAMPLE
|
||||
|
||||
Open some rails file (model, app, etc) and start using the textmate snippets.
|
||||
|
||||
* Contributing snippets
|
||||
|
||||
Please do not ask me to add snippets to the default collection under
|
||||
=/snippets=. This is considered frozen and by customizing =yas/snippet-dirs= you
|
||||
can point yasnippet to good snippet collections out there.
|
||||
|
||||
The =extras/textmate-import.rb= tool can import many actual Textmate
|
||||
snippets. See [[import-textmate]].
|
||||
|
||||
I'm focusing on developping =textmate-import.rb= tool and the =yas-setup.el=
|
||||
files that guide it with more difficult importation. In the future =/snippets=
|
||||
snippets will be deprecated and replaced with =extras/imported=.
|
||||
|
||||
* Documentation, issues, etc
|
||||
|
||||
Please refer to the comprehensive [[docs][documentation]] for full customization and
|
||||
support. If you think you've found a bug, please report it on [[issues][the GitHub issue
|
||||
tracker]]. (please **do not** submit new issues to the old [[googlecode-tracker][googlecode tracker]])
|
||||
|
||||
If you run into problems using YASnippet, or have snippets to contribute, post
|
||||
to the [[forum][yasnippet forum]]. Thank you very much for using YASnippet!
|
||||
@ -18,13 +18,6 @@
|
||||
#+LINK: forum http://groups.google.com/group/smart-snippet
|
||||
|
||||
|
||||
# Internal links
|
||||
|
||||
.. _Organizing Snippets: snippet-organization.html
|
||||
.. _Expanding Snippets: snippet-expansion.html
|
||||
.. _Writing Snippets: snippet-development.html
|
||||
.. _The YASnippet Menu: snippet-menu.html
|
||||
|
||||
*YASnippet* is a template system for Emacs. It allows you to type an
|
||||
abbreviation and automatically expand it into function templates. Bundled
|
||||
language templates includes: C, C++, C#, Perl, Python, Ruby, SQL, LaTeX, HTML,
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user