-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Document stuff a little more organised
- Loading branch information
1 parent
dfd569d
commit 4ebd5e2
Showing
9 changed files
with
62 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# CynthiaConf | ||
|
||
Cynthia's configuration can be written in [`TOML`](https://toml.io/) (`Cynthia.toml`), [`Dhall`](https://dhall-lang.org/) (`Cynthia.dhall`) and [`JSON`]([JSON](https://www.json.org/json-en.html)) (`Cynthia.json`). `TOML` is the current default, and as such, these docs will mostly document CynthiaDocs with TOML examples. | ||
|
||
## Conversion | ||
|
||
Cynthia can convert between config languages using the `cynthiaweb convert <lang>` command. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
# Plugin API's | ||
|
||
# JS/TS | ||
|
||
Currently there is only the JS/TS API available. Most important change you should is that Cynthia `v3` communicates with it's plugins over `STDIO`. In Cynthia `v2` this was done through calling arguments and local HTTP ports, causing loads of overhead. | ||
|
||
Cynthia `v3` aims to bring comfortable communication with it's plugins back to the levels of `v0/ts-draft`, where a Node plugin would be imported and called as a library, then called with an object, on which methods were available to control Cynthia's behaviour. | ||
|
||
The Node package for writing Cynthia plugins can be found at: | ||
|
||
<https://www.npmjs.com/package/@cynthiaweb/plugin-api> | ||
|
||
|
||
|
||
|
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Docs | ||
|
||
Obviously, Cynthia will self-host it's docs once v3 is far enoug. But for now, to keep docs available in this bridging period... Bamn! GitHub Pages (I don't hate them as bad as WordPress, but...) | ||
|
||
A little table-of-content for each subject down below: | ||
|
||
## For everyone | ||
|
||
- [Enabling or disabling Cynthia features](./features.md) | ||
|
||
## For webmasters (AKA Cynthia-admins) | ||
|
||
- [Managing publications: `publications.jsonc`](./Admins/publication/published.jsonc.md) | ||
|
||
- [Configuring Cynthia: `CynthiaConf`](./Admins/configuration/CynthiaConf.md) | ||
|
||
- [Setting up scenes](./Admins/configuration/CynthiaConf/scenes.md) | ||
|
||
- [Writing templates](./Admins/customisation/templates.md) | ||
|
||
## For developers | ||
|
||
Interested in developing on Cynthia itself? Feel free to leave an issue or PR on [the GitHub](https://github.com/strawmelonjuice/CynthiaWebsiteEngine). | ||
|
||
### For plugin developers | ||
|
||
- [Available API's](./Developers/Plugin/apis.md) |