https://github.com/honza/sheepskin

Document authoring utility
https://github.com/honza/sheepskin

Last synced: about 5 hours ago
JSON representation

Document authoring utility

• Host: GitHub
• URL: https://github.com/honza/sheepskin
• Owner: honza
• License: bsd-2-clause
• Created: 2012-04-13T16:28:00.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2012-09-12T16:28:29.000Z (about 12 years ago)
• Last Synced: 2024-04-16T01:44:56.527Z (7 months ago)
• Language: Shell
• Homepage:
• Size: 93.8 KB
• Stars: 18
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Sheep Skin

==========

Sheep Skin is a document authoring utility.  It allows you to write your

document in Markdown and then compile it to HTML, Latex (PDF) and epub.  It's

especially useful for writing long, multi-section documents (such as books or

reports).  It uses Pandoc to parse your Markdown.

How it works

------------

When you invoke the `sheepskin` command, it will create a project directory

structure for you.  From then on, you don't need that command.  The project

contains a `Makefile` which does the rest.  You can customize the CSS, HTML and

Latex templates.

Usage

-----

1.  Download the `sheepskin` file and place it on your `PATH`.

2.  Create a directory for your project.

3.  Run `sheepskin`.  It will ask you some questions and create your project.

4.  Your text should live in the `src/` directory.  Chapters will be ordered

    alphabetically.

5.  Compile a version using the provided `Makefile`.

    * `make web`

    * `make latex`

    * `make epub`

6.  View the compiled output in `_build/`.

Requirements

------------

* Pandoc - [Installation instructions][1]

* LaTex - On Mac OSX, I'd recommend using [Basic Tex][2].  It's a very small

  package. You may need to install the `fontspect` package.

* [Kindle Previewer][3] (Optional) - This is for compiling the epub file to mobi and

  previewing.

License

-------

BSD, short and sweet.

[1]: http://johnmacfarlane.net/pandoc/installing.html

[2]: http://www.tug.org/mactex/2011/morepackages.html

[3]: http://www.amazon.com/gp/feature.html/?docId=1000765261