From 4729c6df95b6ce6d60c3873a1fb2aba73dcf5c67 Mon Sep 17 00:00:00 2001 From: Jan Larres Date: Wed, 1 Oct 2014 12:38:42 +1300 Subject: [PATCH] Sync website with README --- _config.yml | 2 +- _layouts/default.html | 11 +++- index.html | 146 +++++++++++++++--------------------------- update_from_readme.py | 33 ++++++++++ 4 files changed, 96 insertions(+), 96 deletions(-) create mode 100755 update_from_readme.py diff --git a/_config.yml b/_config.yml index 6d67c09..0486972 100644 --- a/_config.yml +++ b/_config.yml @@ -1,2 +1,2 @@ markdown: rdiscount -pygments: true +highlighter: pygments diff --git a/_layouts/default.html b/_layouts/default.html index 2b11b45..07eb449 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -23,10 +23,11 @@ width: 650px; } h1 { - font-size: 3.8em; + font-size: 3.0em; color: #dddddd; margin-bottom: 3px; text-shadow: #111111 3px 3px 1px; + text-align: center; } h1 .small { font-size: 0.4em; } h1 a { text-decoration: none; color: #F0E7D5 } @@ -57,6 +58,14 @@ } code { font-family: "Ubuntu Mono", monospace; } hr { border: 0; width: 80%; border-bottom: 1px solid #aaa} + #title { + margin-bottom: 50px; + } + #title p { + font-size: 1.8em; + text-align: center; + color: #999999; + } .footer { text-align:center; padding-top:30px; font-style: italic; } diff --git a/index.html b/index.html index 1306880..39b8e95 100644 --- a/index.html +++ b/index.html @@ -3,117 +3,75 @@ layout: default title: Tagbar, the Vim class outline viewer --- -Fork me on GitHub - +Fork me on GitHub
- -

Tagbar

-

The Vim class outline viewer

- -
- Vim plugin that displays tags in a window, ordered by class etc. -
- -

- Tagbar is a vim plugin for browsing the tags of source code files. It - provides a sidebar that displays the ctags-generated tags of the - current file, ordered by their scope. This means that for example - methods in C++ are displayed under the class they are defined in. -

- -

Dependencies

-

Vim 7.0
- Exuberant ctags 5.5

- -

Install

-

- Extract the archive or clone the repository into a directory in your - 'runtimepath' or use - pathogen. - Don't forget to run :helptags so you can - access the documentation with :help tagbar. -

- -

- Note: Vim versions < 7.0.167 have a bug that prevents Tagbar from - working. If you are affected by this use this alternate Tagbar - download instead: - zip. - It is on par with version 2.2 but probably won't be updated after - that. -

- -

- If the ctags executable is not installed in one of the directories in - your $PATH environment variable you have to set the - g:tagbar_ctags_bin variable, see the documentation for more info. -

- -

Quickstart

-

- Put something like the following into your ~/.vimrc: - -{% highlight vim %} -nmap :TagbarToggle -{% endhighlight %} - - Then the F8 key will toggle the Tagbar window. You can of course use - any shortcut you want. For more flexible ways to open and close the - window (and the rest of the functionality) see the documentation. -

- -

Support for additional filetypes

- -

- The - wiki - describes how to get better support for JavaScript with jsctags and - extensions for additional filetypes that are not supported by - Exuberant Ctags by default. If you create your own extension please - add it to the wiki! -

- -

Screenshots

- - - - -

License

-

Vim license

- -

Author

-

Jan Larres <jan@majutsushi.net>

- -

Download

-

Latest stable release

+
+

Tagbar

+

A class outline viewer for Vim

+
+

What Tagbar is

Tagbar is a Vim plugin that provides an easy way to browse the tags of the +current file and get an overview of its structure. It does this by creating a +sidebar that displays the ctags-generated tags of the current file, ordered by +their scope. This means that for example methods in C++ are displayed under +the class they are defined in.

What Tagbar is not

Tagbar is not a general-purpose tool for managing tags files. It only +creates the tags it needs on-the-fly in-memory without creating any files. +tags file management is provided by other plugins, like for example +easytags.

Dependencies

Vim 7.0 (But see note below)
+Exuberant ctags 5.5

Installation

Extract the archive or clone the repository into a directory in your +'runtimepath', or use a plugin manager of your choice like +pathogen. Don't forget to run +:helptags if your plugin manager doesn't do it for you so you can access the +documentation with :help tagbar.

Note: Vim versions < 7.0.167 have a bug that prevents Tagbar from working. If +you are affected by this use this alternate Tagbar download instead: +zip. It is on par with +version 2.2 but probably won't be updated after that due to the amount of +changes required.

If the ctags executable is not installed in one of the directories in your +$PATH environment variable you have to set the g:tagbar_ctags_bin +variable, see the documentation for more info.

Quickstart

Put something like the following into your ~/.vimrc:

nmap <F8> :TagbarToggle<CR>
+

If you do this the F8 key will toggle the Tagbar window. You can of course use +any shortcut you want. For more flexible ways to open and close the window +(and the rest of the functionality) see the documentation.

Support for additional filetypes

For filetypes that are not supported by Exuberant Ctags check out the +wiki to see whether other projects +offer support for them and how to use them. Please add any other +projects/configurations that you find or create yourself so that others can +benefit from them, too.

Note: If the file structure display is wrong

If you notice that there are some errors in the way your file's structure is +displayed in Tagbar, please make sure that the bug is actually in Tagbar +before you report an issue. Since Tagbar uses +exuberant-ctags and compatible programs to do +the actual file parsing, it is likely that the bug is actually in the program +responsible for that filetype instead.

There is an example in :h tagbar-issues about how to run ctags manually so +you can determine where the bug actually is. If the bug is actually in ctags, +please report it on their website instead, as there is nothing I can do about +it in Tagbar. Thank you!

You can also have a look at ctags bugs that have previously been filed +against Tagbar.

Screenshots

screenshot1 +screenshot2

License

Vim license, see LICENSE

Maintainer

Jan Larres <jan@majutsushi.net>

+

Download

+

Latest stable release

{% for post in site.posts limit:1 %} {{ post.title }} ({{ post.date | date:"%Y-%m-%d" }}) zip - tar +tar {{ post.content }} {% endfor %} Old releases - -

Latest development version

-

+

Latest development version

+

Download as: zip - tar -

-

+tar +

+

You can also clone the project with Git by running: 

$ git clone git://github.com/majutsushi/tagbar
-

- -
+

+
get the source code on GitHub : majutsushi/tagbar -
- +
diff --git a/update_from_readme.py b/update_from_readme.py new file mode 100755 index 0000000..27a5ef1 --- /dev/null +++ b/update_from_readme.py @@ -0,0 +1,33 @@ +#!/usr/bin/env python +# This script is originally from the YouCompleteMe project. + +from bs4 import BeautifulSoup +from markdown import markdown +import fileinput + +markdown_lines = list(fileinput.input()) + +# Delete the header +del markdown_lines[:2] + +markdown_source = ''.join(markdown_lines) + +with open('index.html', 'r+') as content_file: + content = content_file.read() + + new_contents = markdown(unicode(markdown_source, 'utf-8'), + extensions=['fenced_code']) + new_tags = BeautifulSoup(new_contents, 'html5lib') + + # soup = BeautifulSoup(content, "html5lib") + # Use the normal html parser so it doesn't add html/body tags + # around our fragment + soup = BeautifulSoup(content, "html.parser") + elem = soup.find(id="markdown-output") + elem.clear() + for new_elem in new_tags.body.contents: + elem.append(new_elem) + + content_file.seek(0) + content_file.truncate() + content_file.write(str(soup))