moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updates RE: HJSON

This commit is contained in:
Bryan Ashby 2019-03-03 10:14:07 -07:00
parent a57f823da5
commit 1b82fc86e7
No known key found for this signature in database
GPG Key ID: B49EB437951D2542
3 changed files with 5 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/_includes/nav.md
View File

@ -13,9 +13,8 @@
- Configuration
- [Creating Config Files]({{ site.baseurl }}{% link configuration/creating-config.md %})
- [SysOp Setup]({{ site.baseurl }}{% link configuration/sysop-setup.md %})
- [Editing HJSON]({{ site.baseurl }}{% link configuration/editing-hjson.md %})
- [System Configuration]({{ site.baseurl }}{% link configuration/config-hjson.md %})
- [HJSON General]({{ site.baseurl }}{% link configuration/hjson.md %})
- [HJSON Config Files]({{ site.baseurl }}{% link configuration/hjson.md %})
- [Menus]({{ site.baseurl }}{% link configuration/menu-hjson.md %})
- [Prompts]({{ site.baseurl }}{% link configuration/prompt-hjson.md %})
- [Directory Structure]({{ site.baseurl }}{% link configuration/directory-structure.md %})

20
docs/configuration/editing-hjson.md
View File

@ -1,20 +0,0 @@
---
layout: page
title: Editing Hjson
---
Hjson is a syntax extension to JSON. It's NOT a proposal to replace JSON or to incorporate it into the JSON spec itself.
It's intended to be used like a user interface for humans, to read and edit before passing the JSON data to the machine.
You can find more info at the [Hjson.org website](http://hjson.org/).
## Editor Plugins
### Visual Studio Code
[Visual Studio Code](https://code.visualstudio.com/) has a nice Hjson extension that can be installed from
within the IDE. It provides syntax highlighting to make it clear when you've made a syntax mistake within
a config file.
### Notepad++
[Notepad++](https://notepad-plus-plus.org) has an Hjson plugin that provides syntax highlighting and other
usual text editor features. The plugin can be found [here](https://github.com/laktak/npp-hjson).

8
docs/configuration/hjson.md
View File

@ -1,6 +1,6 @@
---
layout: page
title: HJSON General Information
title: HJSON Config Files
---
## JSON for Humans!
HJSON is the configuration file format used by ENiGMA½ for [System Configuration](config-hjson.md), [Menus](menu-hjson.md), [Prompts](prompt-hjson.md), etc. [HJSON](https://hjson.org/) is is [JSON](https://json.org/) for humans!
@ -32,9 +32,9 @@ Note that `someSection` is the configuration *section* (or *block*) and `foo: ba
HJSON is a text file format, and ENiGMA½ configuration files **should always be saved as UTF-8**.
It is **highly** recommended to use a text editor that has HJSON support. A few (but not all!) examples include:
* Sublime Text 3 via the `sublime-hjson` package.
* Visual Studio code via the `vscode-hjson` plugin.
* Notepad++ via the `npp-hjson` plugin.
* [Sublime Text](https://www.sublimetext.com/) via the `sublime-hjson` package.
* [Visual Studio Code](https://code.visualstudio.com/) via the `vscode-hjson` plugin.
* [Notepad++](https://notepad-plus-plus.org) via the `npp-hjson` plugin.
See https://hjson.org/users.html for more more editors & plugins.