GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → dohliam → Asciidoc Kate

dohliam / Asciidoc Kate

AsciiDoc/AsciiDoctor syntax highlighting plugin for Kate editor/KatePart

Labels

syntax-highlightingasciidocasciidoctoreditor-plugin

Projects that are alternatives of or similar to Asciidoc Kate

asciidoctor-katex
Asciidoctor extension for converting latexmath using KaTeX at build time
Stars: ✭ 16 (+220%)
Mutual labels:  asciidoc, asciidoctor
AsciiDocQuickLook
A QuickLook plugin to preview AsciiDoc files.
Stars: ✭ 24 (+380%)
Mutual labels:  asciidoc, asciidoctor
asciidoctor-htmlbook
Asciidoctor HTMLBook is an Asciidoctor backend for converting AsciiDoc documents to HTMLBook documents.
Stars: ✭ 31 (+520%)
Mutual labels:  asciidoc, asciidoctor
Emacs Easy Hugo
Emacs major mode for managing hugo
Stars: ✭ 235 (+4600%)
Mutual labels:  asciidoc, asciidoctor
Gradle Multi Project Example
Gradle 多项目管理示例
Stars: ✭ 283 (+5560%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor Intellij Plugin
AsciiDoc plugin for products on the IntelliJ platform (IDEA, RubyMine, etc)
Stars: ✭ 250 (+4900%)
Mutual labels:  asciidoc, asciidoctor
asciidoctor-rfc
AsciiRFC: an AsciiDoc/asciidoctor backend to produce RFC XML v3 (RFC 7991) and v2 (RFC 7749)
Stars: ✭ 14 (+180%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor Browser Extension
⚪️ An extension for web browsers that converts AsciiDoc files to HTML using Asciidoctor.js.
Stars: ✭ 152 (+2940%)
Mutual labels:  asciidoc, asciidoctor
asciidoctor-lein-plugin
A Leiningen plugin for generating documentation using Asciidoctor
Stars: ✭ 26 (+420%)
Mutual labels:  asciidoc, asciidoctor
bitbucket-asciidoc-plugin
An add-on for Atlassian Bitbucket Server to render AsciiDoc files.
Stars: ✭ 20 (+300%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor Web Pdf
Convert AsciiDoc documents to PDF using web technologies
Stars: ✭ 219 (+4280%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor
💎 A fast, open source text processor and publishing toolchain, written in Ruby, for converting AsciiDoc content to HTML 5, DocBook 5, and other formats.
Stars: ✭ 3,905 (+78000%)
Mutual labels:  asciidoc, asciidoctor
Asciidoctor Reveal.js
🔮 A reveal.js converter for Asciidoctor and Asciidoctor.js. Write your slides in AsciiDoc!
Stars: ✭ 219 (+4280%)
Mutual labels:  asciidoc, asciidoctor
elm-syntax-highlighting
Syntax Highlighting for Elm in Sublime Text
Stars: ✭ 27 (+440%)
Mutual labels:  syntax-highlighting, editor-plugin
Asciidoctor Epub3
📘 Asciidoctor EPUB3 is a set of Asciidoctor extensions for converting AsciiDoc to EPUB3 & KF8/MOBI
Stars: ✭ 166 (+3220%)
Mutual labels:  asciidoc, asciidoctor
eclipse-asciidoctor-editor
An eclipse editor for asciidoctor files
Stars: ✭ 45 (+800%)
Mutual labels:  asciidoc, asciidoctor
Infoq Mini Book
Template project for creating an InfoQ Mini-Book with Asciidoctor
Stars: ✭ 147 (+2840%)
Mutual labels:  asciidoc, asciidoctor
Ebook Template
Template to create PDF, ePub and Kindle books with Asciidoctor
Stars: ✭ 150 (+2900%)
Mutual labels:  asciidoc, asciidoctor
middleman-asciidoc
🔰 AsciiDoc support for Middleman 4. (In Middleman 3, AsciiDoc support is provided by a core extension).
Stars: ✭ 24 (+380%)
Mutual labels:  asciidoc, asciidoctor
Doctoolchain
a Gradle based AsciiDoc Toolchain for Software Architecture Documentation
Stars: ✭ 355 (+7000%)
Mutual labels:  asciidoc, asciidoctor
View All Similar Projects ➔

asciidoc-kate - An AsciiDoc/AsciiDoctor plugin for Kate editor/KatePart

The XML file in this repository (asciidoc.xml) contains rules for highlighting the syntax of AsciiDoc and AsciiDoctor markup files in Kate, the default text editor for KDE.

Once installed, opening any file with the .adoc extension should automatically highlight AsciiDoc syntax as in the example below:

AsciiDoc syntax highlighting screenshot

This highlighter works fine with Kate or Kwrite (which are both based on KatePart), and should also work with most of the common features of both AsciiDoc and AsciiDoctor.

Installation

Steps to install the AsciiDoc syntax highlighting file:

  1. Download the file asciidoc.xml or clone this repository
  2. Find the folder ~/.kde/share/apps/katepart/syntax/ on your system (create it if it does not already exist)
  3. Move asciidoc.xml into ~/.kde/share/apps/katepart/syntax/
  4. Open or restart Kate to use the syntax highlighter.

Default syntax highlighting files for Kate are usually stored in the folder /usr/share/kde4/apps/katepart/syntax/. However, custom syntax highlighters should probably be saved in the local syntax highlighting folder (~/.kde/share/apps/katepart/syntax/) in the user's home directory so that they don't get accidentally overwritten during an update.

NOTE: The above applies to KDE 4. If you are using Plasma 5, the local folder for Kate syntax files has changed to ~/.local/share/katepart5/syntax/.

Usage

Files with the extension .ad, .adoc or .asciidoc will automatically be highlighted using the rules in asciidoc.xml. Plain text or other files can be forced to use AsciiDoc highlighting rules by selecting AsciiDoc from the Highlighting menu:

  • Tools > Highlighting > Markup > AsciiDoc

Issues

Although most basic formatting is working and should be fine for normal use, there are still many advanced features from the AsciiDoc / AsciiDoctor spec that are not supported yet. Some (like includes and complex attributes) can't feasibly be supported in Kate due to limitations of the editor itself (an editor like Atom with an actual HTML preview feature for AsciiDoc files would probably be better if you need these features).

However, it would be great to support as many features as possible within Kate/Kwrite. If you have a fix for something (or an idea for a new feature), feel free to submit a PR!

License

Based on kate-markdown by Claes Holmerson.

Dual-Licensed under both GPL and BSD licenses.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].