search

asciidoctor / atom-language-asciidoc

⚛ AsciiDoc language package for the Atom editor.
https://atom.io/packages/language-asciidoc
MIT License
42 stars 20 forks source link
asciidoc asciidoctor atom languages

readme

:information_source: Information :information_source:

GitHub is sunsetting Atom on December 15, 2022.
As a result, we recommend migrating to an alternative solution. The Asciidoctor community is now focusing on providing the best writing experience using the IntelliJ platform or Visual Studio Code.

On December 15, 2022, this repository will be archived.

AsciiDoc Language Package for Atom

Atom Package Atom Package Downloads Build Status (Linux) Build Status (Windows) MIT License

Adds syntax highlighting and snippets to AsciiDoc files. Supports Asciidoctor-specific features.

NOTE: This package recognizes the modern AsciiDoc syntax endorsed by Asciidoctor. It does not support the legacy AsciiDoc syntax permitted by Asciidoctor with compat mode enabled or by AsciiDoc Python. Additionally, two-line section titles are not recognized by this package since they confuse both the language highlighter and the writer.

File extension support

The default file extensions for AsciiDoc files are ad, asc, adoc, asciidoc, and asciidoc.txt Changing the file extension to asciidoc.txt is a recommended solution to remain compatibile with .txt based tooling, whilst having a distinct filename related to the AsciiDoc language. To add a different file extension, such at .txt, customize your Atom configuration:

Open the Atom configuration:

Add a custom file type support:

  core:
    ...
    customFileTypes:
      "source.asciidoc": [
          "foo" # all files with `.foo` extension (ex: `documentation.foo`)
          "foobar.txt" # all files with `.foobar.txt` extension  (ex `documentation.foobar.txt`)
      ]
    ...

Then save the configuration file and restart Atom or press ctrl + alt + r to refresh the UI. You should now see the new file type recognized by the atom-language-asciidoc package.

Contributing

In the spirit of free software, everyone is encouraged to help improve this project.

To contribute code, simply fork the project on GitHub, hack away and send a pull request with your proposed changes. We have a dedicated guide to get you started.

Feel free to use the issue tracker to provide feedback or suggestions in other ways.