Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olivierjm/previewer
Preview json file for https://github.com/TinasheMzondiwa/cis-hymnals
https://github.com/olivierjm/previewer
Last synced: 27 days ago
JSON representation
Preview json file for https://github.com/TinasheMzondiwa/cis-hymnals
- Host: GitHub
- URL: https://github.com/olivierjm/previewer
- Owner: OlivierJM
- License: mit
- Created: 2023-05-28T08:32:34.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-27T07:23:22.000Z (12 months ago)
- Last Synced: 2024-10-15T03:49:32.072Z (2 months ago)
- Language: TypeScript
- Homepage: https://previewer-psi.vercel.app
- Size: 216 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Previewer
This is little utility to help preview hymns in different formats, currently we support markdown and html. It also allows for editing the hymns with a WYSIWYG editor.
## Demo
https://previewer-psi.vercel.app
## Run Locally
Clone the project
```bash
git clone https://github.com/OlivierJM/previewer.git
```
Go to the project directory
```bash
cd previewer
```
Install dependencies
```bash
npm install
```
Start the dev server
```bash
npm run dev
```
## Features
- Song listing
- Song Preview
- Song editing
- HTML/Markdown
- Upload/Url JSON preview
### Supported file structure
Currently we support JSON files that have a structure that looks like this
```json
[
{
"title": "3 Face To Face",
"number": 3,
"content": "
some html here, content can also in markdown
"
}
]
```
The above HTML or Markdown can be in the content property, the previewer will render whichever is provided accordingly.
Another supported format is the following
```json
[
{
"title": "3 Face To Face",
"number": 3,
"markdown": "### some markdown here"
}
]
```
In the above example, the property name is markdown instead of content, this too is supported as long as the provided content is valid markdown.
## Feedback
If you have any feedback, please reach out to us at [email protected] or create an issue.
## License
[MIT](https://choosealicense.com/licenses/mit/)