https://github.com/gma/nesta

File Based CMS and Static Site Generator
https://github.com/gma/nesta

cms file-based-cms haml markdown ruby sass sinatra sinatra-application ssg static-site-generator textile

Last synced: 4 days ago
JSON representation

File Based CMS and Static Site Generator

• Host: GitHub
• URL: https://github.com/gma/nesta
• Owner: gma
• License: mit
• Created: 2008-11-27T00:57:49.000Z (about 16 years ago)
• Default Branch: main
• Last Pushed: 2024-10-05T07:08:44.000Z (3 months ago)
• Last Synced: 2024-10-29T15:11:25.333Z (about 2 months ago)
• Topics: cms, file-based-cms, haml, markdown, ruby, sass, sinatra, sinatra-application, ssg, static-site-generator, textile
• Language: Ruby
• Homepage: http://nestacms.com
• Size: 865 KB
• Stars: 902
• Watchers: 19
• Forks: 122
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• Open-Source-Ruby-and-Rails-Apps - nestaCMS - A lightweight CMS, implemented in Sinatra. 🔥 (Happy Exploring 🤘)

README

        
# File Based CMS and Static Site Generator

Nesta is a lightweight CMS for building content sites and blogs, written in

[Sinatra].

Content can be written in [Markdown] or [Textile], stored in text files on your

computer. There is no database.

You do your writing in your text editor.

Publish by pushing your changes to a git repository that's setup to deploy your

changes to the web.

[Sinatra]: http://www.sinatrarb.com/ "Sinatra"

[Markdown]: http://daringfireball.net/projects/markdown/

[Textile]: http://textism.com/tools/textile/

## Installation

Begin by [installing Ruby], then the Nesta gem:

    $ gem install nesta

Use the `nesta` command to generate a new site:

    $ nesta new mysite.com --git  # a git repo is optional, but recommended

Install a few dependencies, and you're away:

    $ cd mysite.com

    $ bundle

You'll find configuration options for your site in `config/config.yml`. The

defaults will work, but you'll want to tweak it before you go very far.

That's it - you can launch a local web server in development mode using

mr-sparkle...

    $ bundle exec mr-sparkle config.ru

...then point your web browser at http://localhost:8080. Start editing

the files in `content/pages` (see the [docs on writing content] for full

instructions).

You can either [deploy it] behind a web server, or build a static version of

your site:

    $ nesta build  # but see config.yml for related settings

[installing Ruby]: https://www.ruby-lang.org/en/documentation/installation/

[docs on writing content]: http://nestacms.com/docs/creating-content/

[deploy it]: https://nestacms.com/docs/deployment/

## Support

There's plenty of information on . If you need some

help with anything feel free to [file an issue], or contact me on Mastodon

([@[email protected]]).

[file an issue]: https://github.com/gma/nesta/issues/new

[@[email protected]]: https://hachyderm.io/@gma

[the blog]: https://nestacms.com/blog

![Tests](https://github.com/gma/nesta/actions/workflows/tests.yml/badge.svg)

## Contributing

If you want to add a new feature, consider [creating an issue] so we can

have a chat before you start coding. I might be able to chip in with ideas on

how to approach it, or suggest that we implement it as a [plugin] (to keep Nesta

itself lean and simple).

[creating an issue]: https://github.com/gma/nesta/issues/new

[plugin]: https://nestacms.com/docs/plugins

-- Graham