Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sitepress/sitepress
Sitepress ruby gems
https://github.com/sitepress/sitepress
Last synced: 3 months ago
JSON representation
Sitepress ruby gems
- Host: GitHub
- URL: https://github.com/sitepress/sitepress
- Owner: sitepress
- License: mit
- Created: 2016-09-12T07:29:44.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T03:21:34.000Z (5 months ago)
- Last Synced: 2024-07-22T02:43:53.495Z (4 months ago)
- Language: Ruby
- Homepage: https://sitepress.cc
- Size: 626 KB
- Stars: 263
- Watchers: 3
- Forks: 17
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Support: support/benchmark_dsl.rb
Awesome Lists containing this project
- Open-Source-Ruby-and-Rails-Apps - sitepress - Sitepress is a file-backed website content manager that can be embedded in popular web frameworks like Rails, run stand-alone, or be compiled into static sites. Its useful for marketing pages or small websites that you need to deploy within your web frameworks. 🔥 (Happy Exploring 🤘)
README
# Sitepress
Sitepress is a file-backed website content manager that can be embedded in popular web frameworks like Rails, run stand-alone, or be compiled into static sites. Its useful for marketing pages or small websites that you need to deploy within your web frameworks.
It features:
* Wide support for templates incuding Erb, Haml, Slim, and more.
* Static site compilation to S3, Netlify, etc.
* Embedable in Rails monoliths
* Frontmatter
* Page models
* Helpers
[](https://github.com/sitepress/sitepress/actions/workflows/test.yml) [](https://codeclimate.com/github/sitepress/sitepress)
## Installation
### Rails Installation
It all starts by running the following from the root of your rails project:
```ruby
bundle add sitepress-rails
```
Then follow the instructions in the [Sitepress Rails](./sitepress-rails) gem.
### Standalone Installation
Install the Sitepress gem on your system:
$ gem install sitepress
Then create a new site:
$ sitepress new my-site
Sitepress will create a new site and download and install the gems it needs. Once that's done run:
$ cd my-site
Then start the Sitepress development server:
$ sitepress server
You should then see the site at http://localhost:8080/. Time to start building something beautiful!
# Features
Sitepress implements a subset of the best features from the [Middleman](http://www.middlemanapp.com/) static site generator including the Site and Parsers::Frontmatter.
## Frontmatter
Frontmatter is a way to attach metadata to content pages. Its a powerful way to enable a team of writers and engineers work together on content. The engineers focus on reading values from frontmatter while the writers can change values.
```haml
---
title: This is a swell doc
meta:
keywords: this, is, a, test
background_color: #0f0
---
%html
%head
%meta(name="keywords" value="#{current_page.data.dig("meta", "keywords")}")
%body(style="background: #{current_page.data["background_color"]};")
%h1=current_page.data["title"]
%p And here's the rest of the content!
```
## Site
The Site accepts a directory path
```irb
> site = Sitepress::Site.new(root_path: "spec/pages")
=> #, @request_path=#>
```
Then you can request a resource by request path:
```irb
> resource = site.get("/test")
=> #, @frontmatter=#>
```
And access the frontmatter data (if available) and body of the template.
```irb
> resource.data
=> {"title"=>"Name", "meta"=>{"keywords"=>"One"}}
> resource.body
=> "\n!!!\n%html\n %head\n %title=current_page.data[\"title\"]\n %body\n %h1 Hi\n %p This is just some content\n %h2 There\n"
```
### Resource globbing
The Site API is a powerful way to query content via resource globbing. For example, if you have a folder full of files but you only want all `.html` files within the `docs` directory, you'd do something like:
```haml
%ol
-site.resources.glob("docs/*.html*").each do |page|
%li=link_to page.data["title"], page.request_path
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sitepress/sitepress.