https://github.com/ionwg/ion-doc

Ion Documentation
https://github.com/ionwg/ion-doc

Last synced: 24 days ago
JSON representation

Ion Documentation

• Host: GitHub
• URL: https://github.com/ionwg/ion-doc
• Owner: ionwg
• Created: 2012-01-26T02:17:36.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2018-05-29T16:09:27.000Z (almost 8 years ago)
• Last Synced: 2025-12-21T13:46:23.827Z (3 months ago)
• Language: CSS
• Homepage:
• Size: 362 KB
• Stars: 50
• Watchers: 8
• Forks: 10
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• apis-tools-development - Ion
• awesome-api-management-tools - Ion
• APIs-tools-collection - Ion
• awesome-api-devtools - Ion
• awesome-rest-api - Ion

README

          
# The Ion Hypermedia Type

This repository contains working drafts of a new media type specification to

be submitted to the Internet Engineering Task Force (IETF) and RFC channels at

the appropriate time.

## Authoring

Draft authoring entails editing AsciiDoc documents.  An example

authoring environment:

* Install GitHub's [Atom](https://atom.io/) editor.

* Install the [Atom Asciidoc plugin](https://github.com/asciidoctor/atom-asciidoc-preview):

        apm install asciidoc-preview

As you edit, ensure you have the asciidoc preview pane open to see the rendered

output.  For example:

![Atom Editor: Enable AsciiDoc Preview](atom-asciidoc-enable-preview.png)