https://github.com/steveklabnik/words

A way to turn markdown into HTML and ebooks
https://github.com/steveklabnik/words

Last synced: 12 days ago
JSON representation

A way to turn markdown into HTML and ebooks

• Host: GitHub
• URL: https://github.com/steveklabnik/words
• Owner: steveklabnik
• License: agpl-3.0
• Created: 2013-09-26T22:36:49.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2013-09-26T23:28:57.000Z (about 11 years ago)
• Last Synced: 2024-10-10T20:19:53.414Z (about 1 month ago)
• Homepage: https://github.com/steveklabnik/words
• Size: 115 KB
• Stars: 102
• Watchers: 4
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Words

A super simple publishing system. I assume you like standard UNIX tools. And

Markdown. And Amazon S3.

Basically, you write some markdown files, and run `make ship`. In return, you

have some HTML (and optionally an epub/mobi/pdf) on S3. You can then point a

domain at it.

Simple is good.

## Getting Started.

Check if you've got what it needs:

```bash

$ make check

```

It will tell you what you need installed, and error out if hard requirements

can't be found.

Next, build:

```bash

$ make

```

Done! It's that easy.

### License

Words is released as Free Software under the AGPLv3. See LICENSE for more

details. If that's scary to you, it means that if you modify this code, and

share it with others, you have to give them the code, too.

Of course, that's my code, not your writing. You can do whatever you want with

that.