Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/breuleux/quaint
The Quaint markup language
https://github.com/breuleux/quaint
markup-language quaint
Last synced: 9 days ago
JSON representation
The Quaint markup language
- Host: GitHub
- URL: https://github.com/breuleux/quaint
- Owner: breuleux
- License: bsd-3-clause
- Created: 2015-01-23T01:14:01.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-30T01:13:35.000Z (over 2 years ago)
- Last Synced: 2024-04-14T09:26:28.962Z (7 months ago)
- Topics: markup-language, quaint
- Language: q
- Homepage: http://breuleux.github.io/quaint/
- Size: 3 MB
- Stars: 33
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Quaint
======
[](https://gitter.im/breuleux/quaint?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Quaint is a markup language similar to Markdown, but more regular and
easier to customize.
**[Website](http://breuleux.github.io/quaint/)**
Quaint is written in [Earl Grey](http://earl-grey.io)
Install
-------
npm install quaint -g
Once installed, you can run `quaint` in a new directory to set up a
project. Plugins can be installed locally and configured with the
following command:
quaint --setup plugin-name
[Usage documentation](http://breuleux.github.io/quaint/usage.html)
Syntax
------
[Syntax](http://breuleux.github.io/quaint/syntax.html)
Plugins
-------
[List of plugins](https://breuleux.github.io/quaint/plugins/index.html)
Command-line
------------
```
Usage: quaint [options]
Options:
-c, --config Path to a configuration file with option values (must be
JSON) [default: "quaint.json"]
-d, --data JSON string or file(s) defining field:value pairs to be
made available inside markup (as {field}):
* key:value
* {"key": value, ...}
* filename.json
* prefix::filename.json
-e, --eval Quaint string to parse directly
-f, --format Format (only html currently supported)
-h, --help Show help [boolean]
--inline Inline resources in the HTML
-o, --out File or directory to save the output to
-p, --plugin Plugin(s) to import:
* Quaint file (injected at the beginning)
* Path to JavaScript file
* Local npm module
* Global npm module
-r, --resources Directory where to put the resources
--resources-url URL for the resources directory
--serve Start server on specified port, in output directory
[default: false]
-s, --stdout Print to standard out [boolean] [default: false]
-t, --template Name of the default template to use
--template-directory Template directory
-v, --verbose Print information about the operations performed
[boolean]
--setup Set up and configure a plugin. [default: false]
-w, --watch Watch for changes to rebuild [default: false]
```
API
---
Simple usage:
```javascript
var quaint = require("quaint");
quaint.toHTML("Hello _italic __[bold words].");
// ==> "Hello italic bold words"
```
Extend with plugins:
```javascript
var quaint = require("quaint");
var qhl = require("quaint-highlight");
q = quaint(qhl({defaultLanguage: "python"}))
q.toHTML("&\n def python_function():\n return 1234");
// ==> code block for python_function highlighted in Python
```