-
Notifications
You must be signed in to change notification settings - Fork 3
/
users.html
1 lines (1 loc) · 7 KB
/
users.html
1
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Hjson, a user interface for JSON</title><meta name="description" content="Hjson, a user interface for JSON. Adds comments, makes it nicer to read and avoids comma mistakes."><meta name="viewport" content="width=device-width"><link rel="canonical" href="https://hjson.github.io"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.6/css/bootstrap.min.css" crossorigin="anonymous"><link rel="stylesheet" type="text/css" href="css/md.css"><link rel="stylesheet" type="text/css" href="css/pg5.css"><script type="text/javascript">0<window.location.href.indexOf("hjson.org")&&(window.location.href="https://hjson.github.io")</script><meta name="twitter:card" content="summary" f><meta name="twitter:site" content="@laktakk"><meta name="twitter:creator" content="@laktakk"><meta name="twitter:title" content="Hjson, a user interface for JSON"><meta name="twitter:description" content="Hjson, a user interface for JSON. Adds comments, makes it nicer to read and avoids comma mistakes."><meta name="twitter:image" content="https://hjson.github.io/icon/hjson-s.png"><link rel="icon" type="image/png" sizes="192x192" href="fav/icon-192x192.png"><link rel="icon" type="image/png" sizes="32x32" href="fav/icon-32x32.png"><link rel="icon" type="image/png" sizes="96x96" href="fav/icon-96x96.png"><link rel="apple-touch-icon" href="fav/icon-192x192.png"><meta name="msapplication-TileImage" content="fav/icon-192x192.png"></head><body><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.2.1/jquery.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.6/js/bootstrap.min.js" crossorigin="anonymous"></script><nav class="navbar navbar-inverse navbar-fixed-top" role="navigation"><div class="container"><div class="navbar-header"><button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-collapse-1"><span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span></button> <a class="navbar-brand" href="."><img src="icon/hjson-st.png">Hjson</a></div><div class="collapse navbar-collapse" id="navbar-collapse-1"><ul class="nav navbar-nav"><li><a class="btn navbar-btn btn-success" href="users.html">Users</a></li><li><a class="btn navbar-btn btn-success" href="download.html">Developers</a></li><li><a href="syntax.html">Syntax</a></li><li><a class="btn navbar-btn btn-danger" href="try.html">Try</a></li><li><a href="faq.html">FAQ</a></li><li><a aria-label="Star hjson on GitHub" data-count-aria-label="# stargazers on GitHub" data-count-api="/repos/hjson/hjson#stargazers_count" data-count-href="/hjson/hjson/stargazers" data-style="mega" data-icon="octicon-star" href="https://github.com/hjson/hjson" class="github-button">Star</a></li></ul></div></div></nav><div id="main"><div class="content"><h2 id="-div-class-hicon-div-tools-for-users"><div class="hicon"></div>Tools for Users</h2><p>If the application does not support Hjson, the best way would be to ask the developer to include it.</p><p>In the meantime, if the application allows JSON configs you can use one of the tools below.</p><h3 id="installation">Installation</h3><p>You have three choices:</p><ul><li><a href="users-bin.html">Download a binary</a> (easy)</li><li><a href="try.html">Use it Online</a> (quick)</li><li><a href="users-src.html">Build from source</a> (hard<em>er</em>)</li></ul><h3 id="usage">Usage</h3><p>To use Hjson with an application that does not support Hjson (yet) but has JSON configs:</p><ol><li><p>Convert your existing config to Hjson (do this only once)</p><p>run: <code>hjson CONFIG.json > CONFIG.hjson</code></p><p>(replace CONFIG with the name of the config file)</p></li><li><p>Edit your config</p><p>Whenever you make changes in CONFIG.hjson you need to update CONFIG.json.</p><p>run: <code>hjson -j CONFIG.hjson > CONFIG.json</code></p></li></ol><h3 id="verify-syntax-lint-">Verify Syntax (lint)</h3><p>You can always check the syntax of an Hjson file by simply running <code>hjson FILE</code> or by pasting it into the <a href="try.html">online tool</a>. It will show you the exact location if it contains any errors.</p><h2 id="-a-id-ed-a-editor-support"><a id="ed"></a> Editor Support</h2><p>These editors support syntax highlighting for Hjson:</p><table><thead><tr><th>Name</th><th>Source</th><th>Package</th></tr></thead><tbody><tr><td>Ace</td><td><a href="https://github.com/ajaxorg/ace">ace</a></td><td><a href="https://github.com/ajaxorg/ace-builds">use mode-hjson</a></td></tr><tr><td>Atom</td><td><a href="https://github.com/hjson/atom-hjson">atom-hjson</a></td><td><a href="https://atom.io/packages/language-hjson">package</a></td></tr><tr><td>Emacs</td><td><a href="https://github.com/hjson/hjson-emacs">emacs-hjson</a></td><td><a href="https://github.com/hjson/hjson-emacs">read me</a></td></tr><tr><td>IntelliJ</td><td><a href="https://github.com/hjson/textmate-hjson">textmate-hjson</a></td><td><a href="https://github.com/hjson/textmate-hjson">read me</a></td></tr><tr><td>Notepad++</td><td><a href="https://github.com/laktak/npp-hjson">npp-hjson</a></td><td><a href="https://github.com/laktak/npp-hjson">read me</a></td></tr><tr><td>Sublime Text</td><td><a href="https://github.com/hjson/sublime-hjson">sublime-hjson</a></td><td><a href="https://packagecontrol.io/packages/Hjson">packagecontrol.io</a></td></tr><tr><td>TextMate compatible</td><td><a href="https://github.com/hjson/textmate-hjson">textmate-hjson</a></td><td><a href="https://github.com/hjson/textmate-hjson">read me</a></td></tr><tr><td>Vim</td><td><a href="https://github.com/hjson/vim-hjson">vim-hjson</a></td><td><a href="https://github.com/hjson/vim-hjson">read me</a></td></tr><tr><td>Visual Studio</td><td><a href="https://github.com/hjson/vs-hjson">vs-hjson</a></td><td><a href="https://visualstudiogallery.msdn.microsoft.com/7517a276-112b-4772-b6d8-5a1e6b0eb281">microsoft.com</a></td></tr><tr><td>Visual Studio Code</td><td><a href="https://github.com/hjson/vscode-hjson">vscode-hjson</a></td><td><a href="https://marketplace.visualstudio.com/items?itemName=laktak.hjson">visualstudio.com</a></td></tr></tbody></table></div><div class="ynav"><a href="users.html">Users</a> <a href="download.html">Developers</a> <a href="syntax.html">Syntax</a> <a href="try.html">Try</a> <a href="faq.html">FAQ</a> <a href="https://github.com/hjson/hjson/issues">Feedback</a> <a href="history.html">History</a></div></div></body><script>!function(a,e,t,n,c,o,g){a.GoogleAnalyticsObject=c,a.ga=a.ga||function(){(a.ga.q=a.ga.q||[]).push(arguments)},a.ga.l=1*new Date,o=e.createElement(t),g=e.getElementsByTagName(t)[0],o.async=1,o.src="//www.google-analytics.com/analytics.js",g.parentNode.insertBefore(o,g)}(window,document,"script",0,"ga"),ga("create","UA-49208230-1","auto"),ga("send","pageview"),$(document).on("click",".navbar-collapse.in",function(a){$(a.target).is("a")&&"dropdown-toggle"!=$(a.target).attr("class")&&$(this).collapse("hide")})</script><script async defer="defer" id="github-bjs" src="https://buttons.github.io/buttons.js"></script></html>