Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mslinn/slim_explorer
Quickly Iterate Slim Language Templates
https://github.com/mslinn/slim_explorer
ruby slim-language
Last synced: about 2 months ago
JSON representation
Quickly Iterate Slim Language Templates
- Host: GitHub
- URL: https://github.com/mslinn/slim_explorer
- Owner: mslinn
- Created: 2022-02-23T21:00:55.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T02:48:33.000Z (about 1 year ago)
- Last Synced: 2024-10-12T09:45:24.120Z (3 months ago)
- Topics: ruby, slim-language
- Language: Ruby
- Homepage: https://mslinn.com/blog/2022/02/22/testing-slim.html
- Size: 579 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Slim Language Explorer
https://user-images.githubusercontent.com/485818/155521347-856ca755-cb89-4bc7-97ce-fa69d091cf7a.mp4
[Slim](https://github.com/slim-template/slim#configuring-slim) is a cool way to generate a potentially
complex HTML block with a minimum of characters.
Most often, Slim is thought of as an alternative to Ruby on Rail's ERB, however it is useful in a broad range of contexts.
When you are trying to figure out how to express HTML in Slim, however, you inevitably rerun the generation
process over and over.
This git project consists of a small Ruby program that launches Slim, whenever a file is modified,
created or deleted within the project.
This allows you to edit the Slim 'program', and view its output each time you save it.
## Installation
1. [Install full Ruby](https://www.ruby-lang.org/en/documentation/installation/); this should include the development tools.
2. Clone this git repo.
3. Install dependent gems. From the cloned git repo directory, type:
```shell
$ bundle install
```
## Slim Language REPL
In some sense, this is a REPL for the Slim Language.
### Command-line Mode
The video above demonstrates command-line mode running in Visual Studio Code.
1) Start a bash shell and type:
```shell
$ ./slim_explorer
```
The contents of `watched/template.slim` are evaluated and stored into `www/raw.html`
using the keys and values stored in file `watched/scope.yaml`.
2) Use the editor of your choice to modify any file in the `watched` directory.
3) The contents of `watched/template.slim` are re-evaluated and `www/raw.html` is updated each
time a file in the `watched` directory is saved, created or deleted.
This continues until interrupted.
### Web Server Mode
1) Start a bash shell and type:
```shell
$ ./slim_explorer serve
```
The contents of `watched/template.slim` are evaluated and stored into `www/index.html`
using the keys and values stored in file `watched/scope.yaml`.
2) The file `www/index.html` will be generated.
Open it in your favorite web browser, either from the file,
or at [http://localhost:3030/index.html](http://localhost:3030/index.html).
This is what it looks like:
3) Use the editor of your choice to modify any file in the `watched` directory.
4) The contents of `watched/template.slim` are re-evaluated and `www/index.html` is updated each time a file in
the `watched` directory is saved, created or deleted.